From 17515b4a7115b14a0383d4a36ea3d4a34f898a1a Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Mon, 5 Oct 2026 23:02:38 +0700 Subject: [PATCH 01/37] feat(mappings): Add static mappings for ONVIF specifications and service metadata (#155) --- onvif/mappings.py | 419 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 419 insertions(+) create mode 100644 onvif/mappings.py diff --git a/onvif/mappings.py b/onvif/mappings.py new file mode 100644 index 00000000..e7249350 --- /dev/null +++ b/onvif/mappings.py @@ -0,0 +1,419 @@ +"""Static mappings for ONVIF specifications and service metadata.""" + +from datetime import date +from typing import Final, TypedDict + + +class WSDLDefinition(TypedDict): + """ONVIF WSDL definition.""" + + filename: str + path: str + binding: str + namespace: str + + +WSDLMap = dict[str, dict[str, WSDLDefinition]] + +ONVIF_WSDL_MAP: Final[dict[str, dict[str, WSDLDefinition]]] = { + "devicemgmt": { + "ver10": { + "filename": "devicemgmt.wsdl", + "path": "ver10/device/wsdl/devicemgmt.wsdl", + "binding": "DeviceBinding", + "namespace": "http://www.onvif.org/ver10/device/wsdl", + } + }, + "events": { + "ver10": { + "filename": "event-vs.wsdl", + "path": "ver10/events/wsdl/event-vs.wsdl", + "binding": "EventBinding", + "namespace": "http://www.onvif.org/ver10/events/wsdl", + } + }, + "pullpoint": { + "ver10": { + "filename": "event-vs.wsdl", + "path": "ver10/events/wsdl/event-vs.wsdl", + "binding": "PullPointSubscriptionBinding", + "namespace": "http://www.onvif.org/ver10/events/wsdl", + } + }, + "notification": { + "ver10": { + "filename": "event-vs.wsdl", + "path": "ver10/events/wsdl/event-vs.wsdl", + "binding": "NotificationProducerBinding", + "namespace": "http://www.onvif.org/ver10/events/wsdl", + } + }, + "subscription": { + "ver10": { + "filename": "event-vs.wsdl", + "path": "ver10/events/wsdl/event-vs.wsdl", + "binding": "SubscriptionManagerBinding", + "namespace": "http://www.onvif.org/ver10/events/wsdl", + } + }, + "pausable_subscription": { + "ver10": { + "filename": "event-vs.wsdl", + "path": "ver10/events/wsdl/event-vs.wsdl", + "binding": "PausableSubscriptionManagerBinding", + "namespace": "http://www.onvif.org/ver10/events/wsdl", + } + }, + "accesscontrol": { + "ver10": { + "filename": "accesscontrol.wsdl", + "path": "ver10/pacs/accesscontrol.wsdl", + "binding": "PACSBinding", + "namespace": "http://www.onvif.org/ver10/accesscontrol/wsdl", + } + }, + "accessrules": { + "ver10": { + "filename": "accessrules.wsdl", + "path": "ver10/accessrules/wsdl/accessrules.wsdl", + "binding": "AccessRulesBinding", + "namespace": "http://www.onvif.org/ver10/accessrules/wsdl", + } + }, + "actionengine": { + "ver10": { + "filename": "actionengine.wsdl", + "path": "ver10/actionengine.wsdl", + "binding": "ActionEngineBinding", + "namespace": "http://www.onvif.org/ver10/actionengine/wsdl", + } + }, + "advancedsecurity": { + "ver10": { + "filename": "advancedsecurity.wsdl", + "path": "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl", + "binding": "AdvancedSecurityServiceBinding", + "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", + } + }, + "jwt": { + "ver10": { + "filename": "advancedsecurity.wsdl", + "path": "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl", + "binding": "JWTBinding", + "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", + } + }, + "keystore": { + "ver10": { + "filename": "advancedsecurity.wsdl", + "path": "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl", + "binding": "KeystoreBinding", + "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", + } + }, + "tlsserver": { + "ver10": { + "filename": "advancedsecurity.wsdl", + "path": "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl", + "binding": "TLSServerBinding", + "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", + } + }, + "dot1x": { + "ver10": { + "filename": "advancedsecurity.wsdl", + "path": "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl", + "binding": "Dot1XBinding", + "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", + } + }, + "authorizationserver": { + "ver10": { + "filename": "advancedsecurity.wsdl", + "path": "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl", + "binding": "AuthorizationServerBinding", + "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", + } + }, + "mediasigning": { + "ver10": { + "filename": "advancedsecurity.wsdl", + "path": "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl", + "binding": "MediaSigningBinding", + "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", + } + }, + "analytics": { + "ver20": { + "filename": "analytics.wsdl", + "path": "ver20/analytics/wsdl/analytics.wsdl", + "binding": "AnalyticsEngineBinding", + "namespace": "http://www.onvif.org/ver20/analytics/wsdl", + } + }, + "ruleengine": { + "ver20": { + "filename": "analytics.wsdl", + "path": "ver20/analytics/wsdl/analytics.wsdl", + "binding": "RuleEngineBinding", + "namespace": "http://www.onvif.org/ver20/analytics/wsdl", + } + }, + "analyticsdevice": { + "ver10": { + "filename": "analyticsdevice.wsdl", + "path": "ver10/analyticsdevice.wsdl", + "binding": "AnalyticsDeviceBinding", + "namespace": "http://www.onvif.org/ver10/analyticsdevice/wsdl", + } + }, + "appmgmt": { + "ver10": { + "filename": "appmgmt.wsdl", + "path": "ver10/appmgmt/wsdl/appmgmt.wsdl", + "binding": "AppManagementBinding", + "namespace": "http://www.onvif.org/ver10/appmgmt/wsdl", + } + }, + "authenticationbehavior": { + "ver10": { + "filename": "authenticationbehavior.wsdl", + "path": "ver10/authenticationbehavior/wsdl/authenticationbehavior.wsdl", + "binding": "AuthenticationBehaviorBinding", + "namespace": "http://www.onvif.org/ver10/authenticationbehavior/wsdl", + } + }, + "credential": { + "ver10": { + "filename": "credential.wsdl", + "path": "ver10/credential/wsdl/credential.wsdl", + "binding": "CredentialBinding", + "namespace": "http://www.onvif.org/ver10/credential/wsdl", + } + }, + "deviceio": { + "ver10": { + "filename": "deviceio.wsdl", + "path": "ver10/deviceio.wsdl", + "binding": "DeviceIOBinding", + "namespace": "http://www.onvif.org/ver10/deviceIO/wsdl", + } + }, + "display": { + "ver10": { + "filename": "display.wsdl", + "path": "ver10/display.wsdl", + "binding": "DisplayBinding", + "namespace": "http://www.onvif.org/ver10/display/wsdl", + } + }, + "doorcontrol": { + "ver10": { + "filename": "doorcontrol.wsdl", + "path": "ver10/pacs/doorcontrol.wsdl", + "binding": "DoorControlBinding", + "namespace": "http://www.onvif.org/ver10/doorcontrol/wsdl", + } + }, + "imaging": { + "ver20": { + "filename": "imaging.wsdl", + "path": "ver20/imaging/wsdl/imaging.wsdl", + "binding": "ImagingBinding", + "namespace": "http://www.onvif.org/ver20/imaging/wsdl", + } + }, + "media": { + "ver10": { + "filename": "media.wsdl", + "path": "ver10/media/wsdl/media.wsdl", + "binding": "MediaBinding", + "namespace": "http://www.onvif.org/ver10/media/wsdl", + }, + }, + "media2": { + "ver20": { + "filename": "media2.wsdl", + "path": "ver20/media/wsdl/media.wsdl", + "binding": "Media2Binding", + "namespace": "http://www.onvif.org/ver20/media/wsdl", + }, + }, + "provisioning": { + "ver10": { + "filename": "provisioning.wsdl", + "path": "ver10/provisioning/wsdl/provisioning.wsdl", + "binding": "ProvisioningBinding", + "namespace": "http://www.onvif.org/ver10/provisioning/wsdl", + }, + }, + "ptz": { + "ver20": { + "filename": "ptz.wsdl", + "path": "ver20/ptz/wsdl/ptz.wsdl", + "binding": "PTZBinding", + "namespace": "http://www.onvif.org/ver20/ptz/wsdl", + }, + }, + "receiver": { + "ver10": { + "filename": "receiver.wsdl", + "path": "ver10/receiver.wsdl", + "binding": "ReceiverBinding", + "namespace": "http://www.onvif.org/ver10/receiver/wsdl", + }, + }, + "recording": { + "ver10": { + "filename": "recording.wsdl", + "path": "ver10/recording.wsdl", + "binding": "RecordingBinding", + "namespace": "http://www.onvif.org/ver10/recording/wsdl", + }, + }, + "replay": { + "ver10": { + "filename": "replay.wsdl", + "path": "ver10/replay.wsdl", + "binding": "ReplayBinding", + "namespace": "http://www.onvif.org/ver10/replay/wsdl", + }, + }, + "schedule": { + "ver10": { + "filename": "schedule.wsdl", + "path": "ver10/schedule/wsdl/schedule.wsdl", + "binding": "ScheduleBinding", + "namespace": "http://www.onvif.org/ver10/schedule/wsdl", + }, + }, + "search": { + "ver10": { + "filename": "search.wsdl", + "path": "ver10/search.wsdl", + "binding": "SearchBinding", + "namespace": "http://www.onvif.org/ver10/search/wsdl", + }, + }, + "thermal": { + "ver10": { + "filename": "thermal.wsdl", + "path": "ver10/thermal/wsdl/thermal.wsdl", + "binding": "ThermalBinding", + "namespace": "http://www.onvif.org/ver10/thermal/wsdl", + }, + }, + "uplink": { + "ver10": { + "filename": "uplink.wsdl", + "path": "ver10/uplink/wsdl/uplink.wsdl", + "binding": "UplinkBinding", + "namespace": "http://www.onvif.org/ver10/uplink/wsdl", + }, + }, +} + +# ONVIF namespace to service name mapping (used globally) +# Format: namespace -> list of (service_name, binding_pattern) +# binding_pattern is used to identify specific binding in multi-binding services +ONVIF_NAMESPACE_MAP: Final[dict[str, tuple[tuple[str, str], ...]]] = { + "http://www.onvif.org/ver10/device/wsdl": (("devicemgmt", "DeviceBinding"),), + "http://www.onvif.org/ver10/events/wsdl": ( + ("events", "EventBinding"), + ("pullpoint", "PullPointSubscriptionBinding"), + ("notification", "NotificationProducerBinding"), + ("subscription", "SubscriptionManagerBinding"), + ("pausable_subscription", "PausableSubscriptionManagerBinding"), + ), + "http://www.onvif.org/ver20/imaging/wsdl": (("imaging", "ImagingBinding"),), + "http://www.onvif.org/ver10/media/wsdl": (("media", "MediaBinding"),), + "http://www.onvif.org/ver20/media/wsdl": (("media2", "Media2Binding"),), + "http://www.onvif.org/ver20/ptz/wsdl": (("ptz", "PTZBinding"),), + "http://www.onvif.org/ver10/deviceIO/wsdl": (("deviceio", "DeviceIOBinding"),), + "http://www.onvif.org/ver10/display/wsdl": (("display", "DisplayBinding"),), + "http://www.onvif.org/ver20/analytics/wsdl": ( + ("analytics", "AnalyticsEngineBinding"), + ("ruleengine", "RuleEngineBinding"), + ), + "http://www.onvif.org/ver10/analyticsdevice/wsdl": ( + ("analyticsdevice", "AnalyticsDeviceBinding"), + ), + "http://www.onvif.org/ver10/accesscontrol/wsdl": ( + ("accesscontrol", "PACSBinding"), + ), + "http://www.onvif.org/ver10/doorcontrol/wsdl": ( + ("doorcontrol", "DoorControlBinding"), + ), + "http://www.onvif.org/ver10/accessrules/wsdl": ( + ("accessrules", "AccessRulesBinding"), + ), + "http://www.onvif.org/ver10/actionengine/wsdl": ( + ("actionengine", "ActionEngineBinding"), + ), + "http://www.onvif.org/ver10/provisioning/wsdl": ( + ("provisioning", "ProvisioningBinding"), + ), + "http://www.onvif.org/ver10/receiver/wsdl": (("receiver", "ReceiverBinding"),), + "http://www.onvif.org/ver10/recording/wsdl": (("recording", "RecordingBinding"),), + "http://www.onvif.org/ver10/replay/wsdl": (("replay", "ReplayBinding"),), + "http://www.onvif.org/ver10/schedule/wsdl": (("schedule", "ScheduleBinding"),), + "http://www.onvif.org/ver10/search/wsdl": (("search", "SearchBinding"),), + "http://www.onvif.org/ver10/thermal/wsdl": (("thermal", "ThermalBinding"),), + "http://www.onvif.org/ver10/uplink/wsdl": (("uplink", "UplinkBinding"),), + "http://www.onvif.org/ver10/appmgmt/wsdl": (("appmgmt", "AppManagementBinding"),), + "http://www.onvif.org/ver10/authenticationbehavior/wsdl": ( + ("authenticationbehavior", "AuthenticationBehaviorBinding"), + ), + "http://www.onvif.org/ver10/credential/wsdl": ( + ("credential", "CredentialBinding"), + ), + "http://www.onvif.org/ver10/advancedsecurity/wsdl": ( + ("advancedsecurity", "AdvancedSecurityServiceBinding"), + ("jwt", "JWTBinding"), + ("keystore", "KeystoreBinding"), + ("tlsserver", "TLSServerBinding"), + ("dot1x", "Dot1XBinding"), + ("authorizationserver", "AuthorizationServerBinding"), + ("mediasigning", "MediaSigningBinding"), + ), +} + +ONVIF_VERSION_MAP: Final[dict[tuple[int, int], date]] = { + (1, 0): date(2008, 11, 1), + (1, 10): date(2009, 7, 1), + (1, 20): date(2010, 6, 1), + (2, 0): date(2010, 11, 1), + (2, 10): date(2011, 6, 1), + (2, 11): date(2012, 1, 1), + (2, 20): date(2012, 9, 1), + (2, 21): date(2012, 12, 1), + (2, 30): date(2013, 5, 1), + (2, 40): date(2013, 8, 1), + (2, 41): date(2013, 12, 1), + (2, 42): date(2014, 6, 1), + (2, 50): date(2014, 12, 1), + (2, 60): date(2015, 6, 1), + (2, 61): date(2015, 12, 1), + (16, 6): date(2016, 6, 1), + (16, 12): date(2016, 12, 1), + (17, 6): date(2017, 6, 1), + (17, 12): date(2017, 12, 1), + (18, 6): date(2018, 6, 1), + (18, 12): date(2018, 12, 1), + (19, 6): date(2019, 6, 1), + (19, 12): date(2019, 12, 1), + (20, 6): date(2020, 6, 1), + (20, 12): date(2020, 12, 1), + (21, 6): date(2021, 6, 1), + (21, 12): date(2021, 12, 1), + (22, 6): date(2022, 6, 1), + (22, 12): date(2022, 12, 1), + (23, 6): date(2023, 6, 1), + (23, 12): date(2023, 12, 1), + (24, 6): date(2024, 6, 1), + (24, 12): date(2024, 12, 1), + (25, 6): date(2025, 6, 1), + (25, 12): date(2025, 12, 1), + (26, 6): date(2026, 6, 1), +} From 291258f4445b665e9546adcb6cbf0cfb16f56daa Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Mon, 5 Oct 2026 23:11:32 +0700 Subject: [PATCH 02/37] refactor(utils): Update ONVIF mappings on utilities module (#156) --- onvif/utils/discovery.py | 6 +- onvif/utils/wsdl.py | 505 ++------------------------------------- 2 files changed, 23 insertions(+), 488 deletions(-) diff --git a/onvif/utils/discovery.py b/onvif/utils/discovery.py index c81d8230..a3b2c10e 100644 --- a/onvif/utils/discovery.py +++ b/onvif/utils/discovery.py @@ -11,8 +11,8 @@ from lxml import etree -from onvif.cli.utils import ONVIF_NAMESPACE_MAP from onvif.client import ONVIFClient +from onvif.mappings import ONVIF_NAMESPACE_MAP from onvif.utils.error_handlers import safe_call from onvif.utils.exceptions import ONVIFOperationException @@ -324,7 +324,9 @@ def _process_device( if client.services: for service in client.services: namespace = getattr(service, "Namespace", "") - service_mappings = ONVIF_NAMESPACE_MAP.get(namespace, []) + service_mappings: tuple[tuple[str, str], ...] = ( + ONVIF_NAMESPACE_MAP.get(namespace, ()) + ) if not service_mappings: # Unknown namespace diff --git a/onvif/utils/wsdl.py b/onvif/utils/wsdl.py index 1cf91c34..420ca381 100644 --- a/onvif/utils/wsdl.py +++ b/onvif/utils/wsdl.py @@ -6,6 +6,8 @@ import os from typing import Any +from onvif.mappings import ONVIF_WSDL_MAP, WSDLMap + logger = logging.getLogger(__name__) logger.addHandler(logging.NullHandler()) @@ -176,7 +178,9 @@ def _get_base_dir(cls, custom_wsdl_dir=None) -> str | Any: return cls.BASE_DIR @classmethod - def _get_wsdl_map(cls, custom_wsdl_dir=None) -> dict[str, dict[str, Any]] | None: + def _get_wsdl_map( + cls, custom_wsdl_dir: str | None = None + ) -> dict[str, dict[str, Any]] | None: """Get WSDL map with proper base directory. Generates a complete mapping of all ONVIF services to their WSDL definitions. @@ -207,497 +211,26 @@ def _get_wsdl_map(cls, custom_wsdl_dir=None) -> dict[str, dict[str, Any]] | None """ base_dir = cls._get_base_dir(custom_wsdl_dir) - # Determine if we should use flat structure - # Use flat structure if custom_wsdl_dir is explicitly provided OR if global custom dir is set use_flat = custom_wsdl_dir is not None or cls._custom_wsdl_dir is not None # Default structure for WSDL files # If custom_wsdl_dir is provided, use flat structure (direct filename) # Otherwise, use the standard ONVIF directory structure - return { - "devicemgmt": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "devicemgmt.wsdl" - if use_flat - else "ver10/device/wsdl/devicemgmt.wsdl" - ), - ), - "binding": "DeviceBinding", - "namespace": "http://www.onvif.org/ver10/device/wsdl", - } - }, - "events": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "event-vs.wsdl" - if use_flat - else "ver10/events/wsdl/event-vs.wsdl" - ), - ), - "binding": "EventBinding", - "namespace": "http://www.onvif.org/ver10/events/wsdl", - } - }, - "pullpoint": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "event-vs.wsdl" - if use_flat - else "ver10/events/wsdl/event-vs.wsdl" - ), - ), - "binding": "PullPointSubscriptionBinding", - "namespace": "http://www.onvif.org/ver10/events/wsdl", - } - }, - "notification": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "event-vs.wsdl" - if use_flat - else "ver10/events/wsdl/event-vs.wsdl" - ), - ), - "binding": "NotificationProducerBinding", - "namespace": "http://www.onvif.org/ver10/events/wsdl", - } - }, - "subscription": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "event-vs.wsdl" - if use_flat - else "ver10/events/wsdl/event-vs.wsdl" - ), - ), - "binding": "SubscriptionManagerBinding", - "namespace": "http://www.onvif.org/ver10/events/wsdl", - } - }, - "pausable_subscription": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "event-vs.wsdl" - if use_flat - else "ver10/events/wsdl/event-vs.wsdl" - ), - ), - "binding": "PausableSubscriptionManagerBinding", - "namespace": "http://www.onvif.org/ver10/events/wsdl", - } - }, - "accesscontrol": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "accesscontrol.wsdl" - if use_flat - else "ver10/pacs/accesscontrol.wsdl" - ), - ), - "binding": "PACSBinding", - "namespace": "http://www.onvif.org/ver10/accesscontrol/wsdl", - } - }, - "accessrules": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "accessrules.wsdl" - if use_flat - else "ver10/accessrules/wsdl/accessrules.wsdl" - ), - ), - "binding": "AccessRulesBinding", - "namespace": "http://www.onvif.org/ver10/accessrules/wsdl", - } - }, - "actionengine": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "actionengine.wsdl" - if use_flat - else "ver10/actionengine.wsdl" - ), - ), - "binding": "ActionEngineBinding", - "namespace": "http://www.onvif.org/ver10/actionengine/wsdl", - } - }, - "advancedsecurity": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "advancedsecurity.wsdl" - if use_flat - else "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl" - ), - ), - "binding": "AdvancedSecurityServiceBinding", - "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", - } - }, - "jwt": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "advancedsecurity.wsdl" - if use_flat - else "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl" - ), - ), - "binding": "JWTBinding", - "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", - } - }, - "keystore": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "advancedsecurity.wsdl" - if use_flat - else "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl" - ), - ), - "binding": "KeystoreBinding", - "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", - } - }, - "tlsserver": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "advancedsecurity.wsdl" - if use_flat - else "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl" - ), - ), - "binding": "TLSServerBinding", - "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", - } - }, - "dot1x": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "advancedsecurity.wsdl" - if use_flat - else "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl" - ), - ), - "binding": "Dot1XBinding", - "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", - } - }, - "authorizationserver": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "advancedsecurity.wsdl" - if use_flat - else "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl" - ), - ), - "binding": "AuthorizationServerBinding", - "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", - } - }, - "mediasigning": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "advancedsecurity.wsdl" - if use_flat - else "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl" - ), - ), - "binding": "MediaSigningBinding", - "namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", - } - }, - "analytics": { - "ver20": { - "path": os.path.join( - base_dir, - ( - "analytics.wsdl" - if use_flat - else "ver20/analytics/wsdl/analytics.wsdl" - ), - ), - "binding": "AnalyticsEngineBinding", - "namespace": "http://www.onvif.org/ver20/analytics/wsdl", - } - }, - "ruleengine": { - "ver20": { - "path": os.path.join( - base_dir, - ( - "ruleengine.wsdl" - if use_flat - else "ver20/analytics/wsdl/analytics.wsdl" - ), - ), - "binding": "RuleEngineBinding", - "namespace": "http://www.onvif.org/ver20/analytics/wsdl", - } - }, - "analyticsdevice": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "analyticsdevice.wsdl" - if use_flat - else "ver10/analyticsdevice.wsdl" - ), - ), - "binding": "AnalyticsDeviceBinding", - "namespace": "http://www.onvif.org/ver10/analyticsdevice/wsdl", - } - }, - "appmgmt": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "appmgmt.wsdl" - if use_flat - else "ver10/appmgmt/wsdl/appmgmt.wsdl" - ), - ), - "binding": "AppManagementBinding", - "namespace": "http://www.onvif.org/ver10/appmgmt/wsdl", - } - }, - "authenticationbehavior": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "authenticationbehavior.wsdl" - if use_flat - else "ver10/authenticationbehavior/wsdl/authenticationbehavior.wsdl" - ), - ), - "binding": "AuthenticationBehaviorBinding", - "namespace": "http://www.onvif.org/ver10/authenticationbehavior/wsdl", - } - }, - "credential": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "credential.wsdl" - if use_flat - else "ver10/credential/wsdl/credential.wsdl" - ), - ), - "binding": "CredentialBinding", - "namespace": "http://www.onvif.org/ver10/credential/wsdl", - } - }, - "deviceio": { - "ver10": { - "path": os.path.join( - base_dir, - "deviceio.wsdl" if use_flat else "ver10/deviceio.wsdl", - ), - "binding": "DeviceIOBinding", - "namespace": "http://www.onvif.org/ver10/deviceIO/wsdl", - } - }, - "display": { - "ver10": { - "path": os.path.join( - base_dir, - "display.wsdl" if use_flat else "ver10/display.wsdl", - ), - "binding": "DisplayBinding", - "namespace": "http://www.onvif.org/ver10/display/wsdl", - } - }, - "doorcontrol": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "doorcontrol.wsdl" - if use_flat - else "ver10/pacs/doorcontrol.wsdl" - ), - ), - "binding": "DoorControlBinding", - "namespace": "http://www.onvif.org/ver10/doorcontrol/wsdl", - } - }, - "imaging": { - "ver20": { - "path": os.path.join( - base_dir, - ( - "imaging.wsdl" - if use_flat - else "ver20/imaging/wsdl/imaging.wsdl" - ), - ), - "binding": "ImagingBinding", - "namespace": "http://www.onvif.org/ver20/imaging/wsdl", + wsdl_map: WSDLMap = {} + + for service, versions in ONVIF_WSDL_MAP.items(): + wsdl_map[service] = {} + + for version, definition in versions.items(): + filename = definition["filename"] + relative_path = filename if use_flat else definition["path"] + + wsdl_map[service][version] = { + **definition, + "path": os.path.join(base_dir, relative_path), } - }, - "media": { - "ver10": { - "path": os.path.join( - base_dir, - ("media.wsdl" if use_flat else "ver10/media/wsdl/media.wsdl"), - ), - "binding": "MediaBinding", - "namespace": "http://www.onvif.org/ver10/media/wsdl", - }, - }, - "media2": { - "ver20": { - "path": os.path.join( - base_dir, - ("media2.wsdl" if use_flat else "ver20/media/wsdl/media.wsdl"), - ), - "binding": "Media2Binding", - "namespace": "http://www.onvif.org/ver20/media/wsdl", - }, - }, - "provisioning": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "provisioning.wsdl" - if use_flat - else "ver10/provisioning/wsdl/provisioning.wsdl" - ), - ), - "binding": "ProvisioningBinding", - "namespace": "http://www.onvif.org/ver10/provisioning/wsdl", - }, - }, - "ptz": { - "ver20": { - "path": os.path.join( - base_dir, - "ptz.wsdl" if use_flat else "ver20/ptz/wsdl/ptz.wsdl", - ), - "binding": "PTZBinding", - "namespace": "http://www.onvif.org/ver20/ptz/wsdl", - }, - }, - "receiver": { - "ver10": { - "path": os.path.join( - base_dir, - "receiver.wsdl" if use_flat else "ver10/receiver.wsdl", - ), - "binding": "ReceiverBinding", - "namespace": "http://www.onvif.org/ver10/receiver/wsdl", - }, - }, - "recording": { - "ver10": { - "path": os.path.join( - base_dir, - "recording.wsdl" if use_flat else "ver10/recording.wsdl", - ), - "binding": "RecordingBinding", - "namespace": "http://www.onvif.org/ver10/recording/wsdl", - }, - }, - "replay": { - "ver10": { - "path": os.path.join( - base_dir, - "replay.wsdl" if use_flat else "ver10/replay.wsdl", - ), - "binding": "ReplayBinding", - "namespace": "http://www.onvif.org/ver10/replay/wsdl", - }, - }, - "schedule": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "schedule.wsdl" - if use_flat - else "ver10/schedule/wsdl/schedule.wsdl" - ), - ), - "binding": "ScheduleBinding", - "namespace": "http://www.onvif.org/ver10/schedule/wsdl", - }, - }, - "search": { - "ver10": { - "path": os.path.join( - base_dir, - "search.wsdl" if use_flat else "ver10/search.wsdl", - ), - "binding": "SearchBinding", - "namespace": "http://www.onvif.org/ver10/search/wsdl", - }, - }, - "thermal": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "thermal.wsdl" - if use_flat - else "ver10/thermal/wsdl/thermal.wsdl" - ), - ), - "binding": "ThermalBinding", - "namespace": "http://www.onvif.org/ver10/thermal/wsdl", - }, - }, - "uplink": { - "ver10": { - "path": os.path.join( - base_dir, - ( - "uplink.wsdl" - if use_flat - else "ver10/uplink/wsdl/uplink.wsdl" - ), - ), - "binding": "UplinkBinding", - "namespace": "http://www.onvif.org/ver10/uplink/wsdl", - }, - }, - } + + return wsdl_map WSDL_MAP: dict[str, dict[str, Any]] | None = ( None # Will be initialized when first accessed From 0380bc7be16bce53027d2b6cba7e53d99e902054 Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Mon, 5 Oct 2026 23:41:43 +0700 Subject: [PATCH 03/37] refactor(cli): Update ONVIF mappings on CLI module (#157) --- onvif/cli/interactive/shell.py | 160 ++++++++++++++++-------- onvif/cli/utils.py | 79 +++--------- tests/cli/test_cli_interactive_shell.py | 9 +- tests/cli/test_cli_utils.py | 2 + 4 files changed, 125 insertions(+), 125 deletions(-) diff --git a/onvif/cli/interactive/shell.py b/onvif/cli/interactive/shell.py index 3896b503..b04d18e6 100644 --- a/onvif/cli/interactive/shell.py +++ b/onvif/cli/interactive/shell.py @@ -2,6 +2,7 @@ import cmd import sys +from datetime import date from requests.exceptions import RequestException from zeep.exceptions import TransportError @@ -9,6 +10,7 @@ from onvif.cli.helpers.messages import print_interactive_intro from onvif.cli.utils import colorize, get_device_available_services from onvif.client import ONVIFClient +from onvif.mappings import ONVIF_VERSION_MAP from onvif.utils.exceptions import ONVIFOperationException from .context import ShellContext @@ -33,18 +35,32 @@ def __init__(self, client: ONVIFClient, args): cmd.Cmd.__init__(self) self.context = ShellContext(client=client, args=args) + self.device_data = None self._initialize_health_check() + self._initialize_readline() - # Enable tab completion - # for Windows will use pyreadline3 to install readline module + # Set prompt + self.update_prompt() + + self._initialize_device_information() + + self.intro = print_interactive_intro(args, self.context.device_info_text) + + # Start background health check after successful initialization + self.health_check_thread.start() + + def _initialize_readline(self) -> None: + """Initialize readline support and tab completion.""" # pylint: disable=import-outside-toplevel try: import readline # Set completer to this instance readline.set_completer(self.complete) # type: ignore[attr-defined, arg-type] - readline.set_completer_delims(" \t\n`!@#$%^&*()=+[{]}\\|;:'\",<>?") # type: ignore[attr-defined] + readline.set_completer_delims( # type: ignore[attr-defined] + " \t\n`!@#$%^&*()=+[{]}\\|;:'\",<>?" + ) # Enable tab completion, making it compatible with both GNU readline and libedit if ( @@ -52,76 +68,114 @@ def __init__(self, client: ONVIFClient, args): and readline.__doc__ and "libedit" in readline.__doc__ ): - readline.parse_and_bind("bind ^I rl_complete") # type: ignore[attr-defined] + readline.parse_and_bind( # type: ignore[attr-defined] + "bind ^I rl_complete" + ) else: readline.parse_and_bind("tab: complete") # type: ignore[attr-defined] except ImportError: - pass # readline not available on some systems + pass - # Set prompt - self.update_prompt() + def _initialize_device_information(self) -> None: + """Retrieve and format device information.""" + device_info = self._get_device_information() + onvif_version = self._get_onvif_version() - manufacturer = "Unknown" - model = "Unknown" - firmware = "Unknown" - serial = "Unknown" - hardware_id = "Unknown" - onvif_version = "Unknown" + self.context.device_info_text = ( + f"\n\n{colorize('[Device Info]', 'cyan')}\n" + f" Manufacturer : {colorize(device_info['manufacturer'], 'white')}\n" + f" Model : {colorize(device_info['model'], 'white')}\n" + f" Firmware : {colorize(device_info['firmware'], 'white')}\n" + f" Serial : {colorize(device_info['serial'], 'white')}\n" + f" HardwareId : {colorize(device_info['hardware_id'], 'white')}\n" + f" ONVIF Version : {colorize(onvif_version, 'white')}" + ) + def _get_device_information(self) -> dict[str, str]: + """Retrieve basic device information.""" try: - # Get device information and store it self.device_data = self.context.client.devicemgmt().GetDeviceInformation() - manufacturer = getattr(self.device_data, "Manufacturer", "Unknown") - model = getattr(self.device_data, "Model", "Unknown") - firmware = getattr(self.device_data, "FirmwareVersion", "Unknown") - serial = getattr(self.device_data, "SerialNumber", "Unknown") - hardware_id = getattr(self.device_data, "HardwareId", "Unknown") - # Get latest supported ONVIF version + return { + "manufacturer": getattr(self.device_data, "Manufacturer", "Unknown"), + "model": getattr(self.device_data, "Model", "Unknown"), + "firmware": getattr(self.device_data, "FirmwareVersion", "Unknown"), + "serial": getattr(self.device_data, "SerialNumber", "Unknown"), + "hardware_id": getattr(self.device_data, "HardwareId", "Unknown"), + } + except (ONVIFOperationException, KeyError, AttributeError) as e: + if isinstance(e, ONVIFOperationException): + if isinstance(e.original_exception, (RequestException, TransportError)): + self._handle_connection_error() + + return { + "manufacturer": "Unknown", + "model": "Unknown", + "firmware": "Unknown", + "serial": "Unknown", + "hardware_id": "Unknown", + } + + def _get_onvif_version(self) -> str: + """Retrieve and format the latest supported ONVIF version.""" + try: supported_versions = self.context.client.devicemgmt().GetCapabilities( Category="All" )["Device"]["System"]["SupportedVersions"] - if supported_versions: - latest_version = max( - supported_versions, - key=lambda version: ( - getattr(version, "Major", 0), - getattr(version, "Minor", 0), - ), - ) - - major = getattr(latest_version, "Major", "") - minor = getattr(latest_version, "Minor", "") - - if major != "": - onvif_version = ( - f"{major}.{minor} {colorize('[Latest]', 'green')}" - if minor != "" - else str(major) - ) except (ONVIFOperationException, KeyError, AttributeError) as e: if isinstance(e, ONVIFOperationException): if isinstance(e.original_exception, (RequestException, TransportError)): self._handle_connection_error() - else: - # For other errors (e.g., GetCapabilities not supported), we can still proceed - # with basic device info if GetDeviceInformation succeeded. - pass - self.context.device_info_text = ( - f"\n\n{colorize('[Device Info]', 'cyan')}\n" - f" Manufacturer : {colorize(manufacturer, 'white')}\n" - f" Model : {colorize(model, 'white')}\n" - f" Firmware : {colorize(firmware, 'white')}\n" - f" Serial : {colorize(serial, 'white')}\n" - f" HardwareId : {colorize(hardware_id, 'white')}\n" - f" ONVIF Version : {colorize(onvif_version, 'white')}" + return "Unknown" + + if not supported_versions: + return "Unknown" + + latest_version = max( + supported_versions, + key=lambda version: ( + getattr(version, "Major", 0), + getattr(version, "Minor", 0), + ), ) - self.intro = print_interactive_intro(args, self.context.device_info_text) + major = getattr(latest_version, "Major", None) + minor = getattr(latest_version, "Minor", None) - # Start background health check after successful initialization - self.health_check_thread.start() + if major is None: + return "Unknown" + + if minor is None: + return str(major) + + version_key = (major, minor) + release_date = ONVIF_VERSION_MAP.get(version_key) + + version = f"{major}.{minor:02d}" + + if release_date: + version += f" ({release_date.strftime('%B %Y')})" + + if release_date and self._is_latest_released_version(release_date): + version += f" {colorize('[Latest]', 'green')}" + + return version + + def _is_latest_released_version(self, release_date: date) -> bool: + """Return whether the release date is the latest released ONVIF version.""" + today = date.today() + + latest_release = max( + ( + version_date + for version_date in ONVIF_VERSION_MAP.values() + if version_date <= today + ), + default=None, + ) + + return release_date == latest_release def cmdloop(self, intro=None): """Override cmdloop to handle TAB completion manually.""" diff --git a/onvif/cli/utils.py b/onvif/cli/utils.py index 602b9d99..a1fb98e8 100644 --- a/onvif/cli/utils.py +++ b/onvif/cli/utils.py @@ -10,65 +10,7 @@ from functools import lru_cache from typing import Any -# ONVIF namespace to service name mapping (used globally) -# Format: namespace -> list of (service_name, binding_pattern) -# binding_pattern is used to identify specific binding in multi-binding services -ONVIF_NAMESPACE_MAP = { - "http://www.onvif.org/ver10/device/wsdl": [("devicemgmt", "DeviceBinding")], - "http://www.onvif.org/ver10/events/wsdl": [ - ("events", "EventBinding"), - ("pullpoint", "PullPointSubscriptionBinding"), - ("notification", "NotificationProducerBinding"), - ("subscription", "SubscriptionManagerBinding"), - ], - "http://www.onvif.org/ver20/imaging/wsdl": [("imaging", "ImagingBinding")], - "http://www.onvif.org/ver10/media/wsdl": [("media", "MediaBinding")], - "http://www.onvif.org/ver20/media/wsdl": [("media2", "Media2Binding")], - "http://www.onvif.org/ver20/ptz/wsdl": [("ptz", "PTZBinding")], - "http://www.onvif.org/ver10/deviceIO/wsdl": [("deviceio", "DeviceIOBinding")], - "http://www.onvif.org/ver10/display/wsdl": [("display", "DisplayBinding")], - "http://www.onvif.org/ver20/analytics/wsdl": [ - ("analytics", "AnalyticsEngineBinding"), - ("ruleengine", "RuleEngineBinding"), - ], - "http://www.onvif.org/ver10/analyticsdevice/wsdl": [ - ("analyticsdevice", "AnalyticsDeviceBinding") - ], - "http://www.onvif.org/ver10/accesscontrol/wsdl": [("accesscontrol", "PACSBinding")], - "http://www.onvif.org/ver10/doorcontrol/wsdl": [ - ("doorcontrol", "DoorControlBinding") - ], - "http://www.onvif.org/ver10/accessrules/wsdl": [ - ("accessrules", "AccessRulesBinding") - ], - "http://www.onvif.org/ver10/actionengine/wsdl": [ - ("actionengine", "ActionEngineBinding") - ], - "http://www.onvif.org/ver10/provisioning/wsdl": [ - ("provisioning", "ProvisioningBinding") - ], - "http://www.onvif.org/ver10/receiver/wsdl": [("receiver", "ReceiverBinding")], - "http://www.onvif.org/ver10/recording/wsdl": [("recording", "RecordingBinding")], - "http://www.onvif.org/ver10/replay/wsdl": [("replay", "ReplayBinding")], - "http://www.onvif.org/ver10/schedule/wsdl": [("schedule", "ScheduleBinding")], - "http://www.onvif.org/ver10/search/wsdl": [("search", "SearchBinding")], - "http://www.onvif.org/ver10/thermal/wsdl": [("thermal", "ThermalBinding")], - "http://www.onvif.org/ver10/uplink/wsdl": [("uplink", "UplinkBinding")], - "http://www.onvif.org/ver10/appmgmt/wsdl": [("appmgmt", "AppManagementBinding")], - "http://www.onvif.org/ver10/authenticationbehavior/wsdl": [ - ("authenticationbehavior", "AuthenticationBehaviorBinding") - ], - "http://www.onvif.org/ver10/credential/wsdl": [("credential", "CredentialBinding")], - "http://www.onvif.org/ver10/advancedsecurity/wsdl": [ - ("advancedsecurity", "AdvancedSecurityServiceBinding"), - ("jwt", "JWTBinding"), - ("keystore", "KeystoreBinding"), - ("tlsserver", "TLSServerBinding"), - ("dot1x", "Dot1XBinding"), - ("authorizationserver", "AuthorizationServerBinding"), - ("mediasigning", "MediaSigningBinding"), - ], -} +from onvif.mappings import ONVIF_NAMESPACE_MAP def _is_valid_json(s: str) -> bool: @@ -200,10 +142,11 @@ def get_service_required_args(service_name: str) -> list[str] | None: """Get required arguments for services that need them. Returns list of required argument names, or None if service doesn't need args. - Services that require arguments: - - pullpoint, subscription: requires SubscriptionRef + + Services that require arguments: + - pullpoint, subscription, pausable_subscription: requires SubscriptionRef """ - if service_name in ["pullpoint", "subscription"]: + if service_name in ["pullpoint", "subscription", "pausable_subscription"]: return ["SubscriptionRef"] return None @@ -363,7 +306,9 @@ def format_services_list(services_list) -> str: version = getattr(service, "Version", {}) # Get service mappings for this namespace - service_mappings = ONVIF_NAMESPACE_MAP.get(namespace, []) + service_mappings: tuple[tuple[str, str], ...] = ONVIF_NAMESPACE_MAP.get( + namespace, () + ) if not service_mappings: # Unknown namespace @@ -436,7 +381,13 @@ def get_device_available_services(client) -> list: if hasattr(caps, "Events") and caps.Events: # Events namespace has multiple bindings available_services.extend( - ["events", "pullpoint", "notification", "subscription"] + [ + "events", + "pullpoint", + "notification", + "subscription", + "pausable_subscription", + ] ) if hasattr(caps, "Imaging") and caps.Imaging: available_services.append("imaging") diff --git a/tests/cli/test_cli_interactive_shell.py b/tests/cli/test_cli_interactive_shell.py index e75fd994..1fe213a8 100644 --- a/tests/cli/test_cli_interactive_shell.py +++ b/tests/cli/test_cli_interactive_shell.py @@ -123,14 +123,7 @@ def test_builds_device_information_text(self, client, args): assert "2.860.0000000.26.R" in shell.context.device_info_text assert "AM08C90PAG3C79B" in shell.context.device_info_text assert "1.00" in shell.context.device_info_text - assert "2.6" in shell.context.device_info_text - - def test_selects_latest_supported_onvif_version(self, client, args): - """Verify that the highest supported ONVIF version is displayed.""" - shell = self._create_shell(client, args) - - assert "2.6" in shell.context.device_info_text - assert "2.5" not in shell.context.device_info_text + assert "2.06" in shell.context.device_info_text def test_prints_intro_with_device_information(self, client, args): """Verify that the interactive intro receives formatted device information.""" diff --git a/tests/cli/test_cli_utils.py b/tests/cli/test_cli_utils.py index 807266a7..f980bee3 100644 --- a/tests/cli/test_cli_utils.py +++ b/tests/cli/test_cli_utils.py @@ -642,6 +642,7 @@ def test_from_services(self): "pullpoint", "notification", "subscription", + "pausable_subscription", "media", "ptz", } @@ -688,6 +689,7 @@ def test_from_capabilities(self): "pullpoint", "notification", "subscription", + "pausable_subscription", "imaging", "media", "ptz", From 2d787dd208c736638e1288c894650a5e930589cb Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Tue, 6 Oct 2026 00:08:05 +0700 Subject: [PATCH 04/37] ci(publish): Add verification for WSDL and database files in release distributions (#158) --- .github/workflows/python-publish.yml | 79 ++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml index 310f460a..6ebb01ae 100644 --- a/.github/workflows/python-publish.yml +++ b/.github/workflows/python-publish.yml @@ -24,6 +24,85 @@ jobs: python -m pip install build python -m build + - name: Verify WSDL files are included + run: | + python - <<'PY' + import sys + import zipfile + from pathlib import Path + + expected = { + path.relative_to(".").as_posix() + for path in Path("onvif/wsdl").rglob("*.wsdl") + } + + wheels = list(Path("dist").glob("*.whl")) + + if not wheels: + print("ERROR: No wheel was produced.") + sys.exit(1) + + for wheel in wheels: + with zipfile.ZipFile(wheel) as archive: + included = set(archive.namelist()) + + missing = expected - included + + if missing: + print(f"ERROR: Missing WSDL files in {wheel.name}:") + for path in sorted(missing): + print(f" - {path}") + sys.exit(1) + + print( + f"{wheel.name}: all {len(expected)} WSDL files are included." + ) + + print("WSDL package contents verified successfully.") + PY + + - name: Verify database files are included + run: | + python - <<'PY' + import sys + import zipfile + from pathlib import Path + + expected = { + path.relative_to(".").as_posix() + for path in Path("onvif/db").rglob("*.db") + } + + wheels = list(Path("dist").glob("*.whl")) + + if not wheels: + print("ERROR: No wheel was produced.") + sys.exit(1) + + if not expected: + print("ERROR: No database files found in onvif/db.") + sys.exit(1) + + for wheel in wheels: + with zipfile.ZipFile(wheel) as archive: + included = set(archive.namelist()) + + missing = expected - included + + if missing: + print(f"ERROR: Missing database files in {wheel.name}:") + for path in sorted(missing): + print(f" - {path}") + sys.exit(1) + + print( + f"{wheel.name}: all {len(expected)} " + f"database files are included." + ) + + print("Database package contents verified successfully.") + PY + - name: Upload distributions uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: From 4eb94871221943435490305eb229a781fb71b331 Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Tue, 6 Oct 2026 22:40:45 +0700 Subject: [PATCH 05/37] refactor(cli): Optimize ONVIF CLI interactive shell and related modules (#159) * Added type hints to methods in navigation, reference, service, and shell modules for better code clarity and type checking. * Enhanced device information handling by introducing a new method to format device data and using it during shell initialization. * Updated the ONVIF version handling logic to improve version detection and formatting. * Added tests for device information formatting and ONVIF version detection to ensure robustness. --- onvif/cli/helpers/discovery.py | 4 +- onvif/cli/helpers/execution.py | 6 +- onvif/cli/helpers/files.py | 2 + onvif/cli/helpers/messages.py | 10 +- onvif/cli/helpers/products.py | 2 + onvif/cli/helpers/wsdl_parser.py | 8 +- onvif/cli/interactive/context.py | 5 +- onvif/cli/interactive/information.py | 14 +- onvif/cli/interactive/navigation.py | 21 +- onvif/cli/interactive/reference.py | 19 +- onvif/cli/interactive/service.py | 26 +- onvif/cli/interactive/shell.py | 74 ++-- onvif/cli/interactive/utils.py | 29 +- onvif/cli/main.py | 20 +- onvif/cli/utils.py | 6 +- onvif/mappings.py | 23 +- onvif/meta.py | 3 + tests/cli/test_cli_interactive_shell.py | 440 ++++++++++++++++++++++-- tests/cli/test_cli_interactive_utils.py | 11 +- tests/cli/test_cli_main.py | 27 +- 20 files changed, 585 insertions(+), 165 deletions(-) diff --git a/onvif/cli/helpers/discovery.py b/onvif/cli/helpers/discovery.py index 60080fb5..747943a3 100644 --- a/onvif/cli/helpers/discovery.py +++ b/onvif/cli/helpers/discovery.py @@ -1,5 +1,7 @@ """ONVIF discovery helpers.""" +from __future__ import annotations + from datetime import datetime from onvif.cli.utils import colorize @@ -145,7 +147,7 @@ def _print_optional_field( print(f" [{label}] {value}") -def _process_device_selection(protocol, devices): +def _process_device_selection(protocol: str, devices: list) -> tuple | None: """Simple selection (without arrow keys for cross-platform compatibility)""" while True: try: diff --git a/onvif/cli/helpers/execution.py b/onvif/cli/helpers/execution.py index f0ca7357..e825e7c4 100644 --- a/onvif/cli/helpers/execution.py +++ b/onvif/cli/helpers/execution.py @@ -1,5 +1,7 @@ """ONVIF command execution helpers.""" +from __future__ import annotations + import warnings from typing import Any @@ -48,9 +50,7 @@ def execute_command( def setup_warning_format() -> None: """Setup custom warning format to show clean, concise warnings.""" - def custom_warning_format( - message, category, filename, lineno, line=None - ): # pylint: disable=unused-argument + def custom_warning_format(message, category, _filename, _lineno, _line=None): # Show only the warning message without file path and line number return f"{category.__name__}: {message}\n" diff --git a/onvif/cli/helpers/files.py b/onvif/cli/helpers/files.py index 750710fd..042aa073 100644 --- a/onvif/cli/helpers/files.py +++ b/onvif/cli/helpers/files.py @@ -1,5 +1,7 @@ """File processing helpers.""" +from __future__ import annotations + import json import os import sys diff --git a/onvif/cli/helpers/messages.py b/onvif/cli/helpers/messages.py index c9ccd0d3..6f2540cc 100644 --- a/onvif/cli/helpers/messages.py +++ b/onvif/cli/helpers/messages.py @@ -1,12 +1,16 @@ """CLI messages.""" +from __future__ import annotations + +from argparse import Namespace + from onvif.cli.utils import ( colorize, ) -from onvif.meta import __repository__, __version__ +from onvif.meta import __interactive_name__, __repository__, __version__ -def print_interactive_intro(args, device_info_text) -> str: +def print_interactive_intro(args: Namespace, device_info_text: str | None) -> str: """Print interactive shell introduction.""" # Welcome message with enhanced info banner_lines = [ @@ -91,7 +95,7 @@ def print_interactive_intro(args, device_info_text) -> str: INTERACTIVE_HELP = f""" -{colorize(f'ONVIF Interactive Shell — v{__version__}', 'cyan')}\n{colorize(__repository__, 'white')} +{colorize(f'{__interactive_name__} — v{__version__}', 'cyan')}\n{colorize(__repository__, 'white')} {colorize('Basic Commands:', 'yellow')} capabilities, caps - Show device capabilities diff --git a/onvif/cli/helpers/products.py b/onvif/cli/helpers/products.py index 0f222974..c5e999bf 100644 --- a/onvif/cli/helpers/products.py +++ b/onvif/cli/helpers/products.py @@ -1,5 +1,7 @@ """ONVIF products search helpers.""" +from __future__ import annotations + import os import shutil import sqlite3 diff --git a/onvif/cli/helpers/wsdl_parser.py b/onvif/cli/helpers/wsdl_parser.py index 3fe0e654..f734b65b 100644 --- a/onvif/cli/helpers/wsdl_parser.py +++ b/onvif/cli/helpers/wsdl_parser.py @@ -1,5 +1,7 @@ """ONVIF WSDL parser helpers.""" +from __future__ import annotations + import inspect import os import re @@ -37,7 +39,9 @@ class OperationTypeInfo(TypedDict): # pylint: disable=too-many-locals,too-many-statements,too-many-branches -def get_method_documentation(service_obj, method_name: str) -> dict[str, Any] | None: +def get_method_documentation( + service_obj: Any, method_name: str +) -> dict[str, Any] | None: """Extracts documentation from WSDL and parameters from the Python method signature. Returns a dictionary with 'doc', 'required', and 'optional' keys. @@ -171,7 +175,7 @@ def get_method_documentation(service_obj, method_name: str) -> dict[str, Any] | def get_operation_type_info( - service_obj, operation_name: str + service_obj: Any, operation_name: str ) -> OperationTypeInfo | None: """Extract input and output message types from WSDL for a given operation. diff --git a/onvif/cli/interactive/context.py b/onvif/cli/interactive/context.py index 0c06defb..e96a13db 100644 --- a/onvif/cli/interactive/context.py +++ b/onvif/cli/interactive/context.py @@ -1,5 +1,8 @@ """ONVIF Interactive Shell context.""" +from __future__ import annotations + +from argparse import Namespace from dataclasses import dataclass, field from datetime import datetime from typing import Any @@ -14,7 +17,7 @@ class ShellContext: # pylint: disable=too-many-instance-attributes UNSET = object() client: ONVIFClient - args: object + args: Namespace current_service: object | None = None current_service_name: str | None = None diff --git a/onvif/cli/interactive/information.py b/onvif/cli/interactive/information.py index 3508ca85..10e8109c 100644 --- a/onvif/cli/interactive/information.py +++ b/onvif/cli/interactive/information.py @@ -1,5 +1,7 @@ """Information commands implementation.""" +from __future__ import annotations + import cmd from typing import Callable @@ -30,11 +32,11 @@ def do_help(self, arg): else: print(INTERACTIVE_HELP) - def do_shortcuts(self, _line): + def do_shortcuts(self, _line) -> None: """Show available shortcuts.""" print(INTERACTIVE_SHORTCUTS) - def do_info(self, _line): + def do_info(self, _line) -> None: """Show connection and device information.""" # Build connection and CLI options info options_info = [] @@ -92,7 +94,7 @@ def do_info(self, _line): ) print() # Extra newline for spacing - def do_capabilities(self, _line): + def do_capabilities(self, _line) -> None: """Show device capabilities in service format.""" try: if ( @@ -120,11 +122,11 @@ def do_capabilities(self, _line): else: print(f"{colorize('Error:', 'red')} {e}") - def do_caps(self, line): + def do_caps(self, line) -> None: """Show device capabilities (alias for 'capabilities')""" return self.do_capabilities(line) - def do_services(self, _line): + def do_services(self, _line) -> None: """Show available ONVIF services in service format.""" try: if ( @@ -152,7 +154,7 @@ def do_services(self, _line): else: print(f"{colorize('Error:', 'red')} {e}") - def do_debug(self, _line): + def do_debug(self, _line) -> None: """Show debug information.""" if self.context.client.xml_plugin: if self.context.last_method and self.context.last_operation_timestamp: diff --git a/onvif/cli/interactive/navigation.py b/onvif/cli/interactive/navigation.py index 375c5c30..b352a346 100644 --- a/onvif/cli/interactive/navigation.py +++ b/onvif/cli/interactive/navigation.py @@ -1,7 +1,9 @@ """Navigation commands implementation.""" +from __future__ import annotations + import traceback -from typing import Callable +from typing import Any, Callable from onvif.cli.utils import ( colorize, @@ -19,9 +21,10 @@ class NavigationCommands: context: ShellContext _display_grid: Callable[..., None] + _resolve_stored_reference: Callable[[str], Any | None] update_prompt: Callable[[], None] - def do_ls(self, _line): + def do_ls(self, _line) -> None: """List available commands/services like TAB completion.""" if self.context.current_service: # In service mode - show available methods @@ -45,7 +48,7 @@ def do_ls(self, _line): else: print("No commands available") - def do_cd(self, line): + def do_cd(self, line) -> None: """Change to service directory (alias for entering service)""" if not line: print("Usage: cd ") @@ -55,12 +58,12 @@ def do_cd(self, line): return None return self.do_enter_service(line) - def complete_cd(self, text, _line, _begidx, _endidx): + def complete_cd(self, text, _line, _begidx, _endidx) -> list: """Autocomplete service names for cd command.""" services = get_device_available_services(self.context.client) return [s for s in services if s.lower().startswith(text.lower())] - def do_up(self, _line): + def do_up(self, _line) -> None: """Exit current service mode (go up one level)""" if self.context.current_service: print( @@ -74,7 +77,7 @@ def do_up(self, _line): print("Not in service mode") # pylint: disable=too-many-locals,too-many-branches,too-many-statements - def do_enter_service(self, line): + def do_enter_service(self, line) -> None: """Enter service mode with optional arguments for services that require them.""" # Parse service name and arguments parts = line.split(None, 1) @@ -168,8 +171,8 @@ def do_enter_service(self, line): f"and {colorize(f'{len(methods) - 10} more.', 'yellow')}" ) print( - f"Type {colorize('ls', 'cyan')}/press " - f"<{colorize('TAB', 'yellow')}> to see all." + f"Type {colorize('ls', 'cyan')} or press " + f"{colorize('', 'yellow')} to see all." ) else: print(f"{colorize('Available methods:', 'yellow')} {methods_preview}") @@ -180,6 +183,6 @@ def do_enter_service(self, line): if self.context.args.debug: traceback.print_exc() - def do_exit_service(self, line): + def do_exit_service(self, line) -> None: """Exit current service mode (alias for 'up')""" return self.do_up(line) diff --git a/onvif/cli/interactive/reference.py b/onvif/cli/interactive/reference.py index e9558634..d9c42a0f 100644 --- a/onvif/cli/interactive/reference.py +++ b/onvif/cli/interactive/reference.py @@ -1,7 +1,10 @@ """Reference commands implementation.""" +from __future__ import annotations + import json import re +from typing import Any from onvif.cli.utils import colorize @@ -13,7 +16,7 @@ class ReferenceCommands: context: ShellContext - def do_store(self, line): + def do_store(self, line) -> None: """Store last result with a name: store .""" if not line: print("Usage: store ") @@ -61,7 +64,7 @@ def do_store(self, line): f"{colorize(service, 'cyan')}.{colorize(method, 'white')}()" ) - def do_show(self, line): + def do_show(self, line) -> None: """Show stored data: show or show . or show [index]""" if not line: @@ -101,7 +104,7 @@ def _substitute_stored_references(self, params_str: str) -> str: r"\$([a-zA-Z_][a-zA-Z0-9_]*(?:\[[0-9]+\])?(?:\.[a-zA-Z_][a-zA-Z0-9_]*)*)" ) - def replace_reference(match): + def replace_reference(match) -> Any | str: reference = match.group(1) value = self._resolve_stored_reference(reference) @@ -120,7 +123,7 @@ def replace_reference(match): return re.sub(pattern, replace_reference, params_str) - def _resolve_stored_reference(self, reference: str): + def _resolve_stored_reference(self, reference: str) -> Any | None: """Resolve stored data reference like 'profiles[0].token' or 'profiles.Token'. Args: @@ -171,7 +174,7 @@ def _resolve_stored_reference(self, reference: str): return current - def complete_show(self, text, line, _begidx, _endidx): + def complete_show(self, text, line, _begidx, _endidx) -> list: """Autocomplete stored variable names for show command.""" # Get the part being completed parts = line.split() @@ -180,7 +183,7 @@ def complete_show(self, text, line, _begidx, _endidx): return [name for name in self.context.stored_data if name.startswith(text)] return [] - def do_rm(self, line): + def do_rm(self, line) -> None: """Remove stored data: rm """ if not line: print("Usage: rm ") @@ -193,11 +196,11 @@ def do_rm(self, line): else: print(f"{colorize('Error:', 'red')} No stored data named '{line}'") - def complete_rm(self, text, _line, _begidx, _endidx): + def complete_rm(self, text, _line, _begidx, _endidx) -> list: """Autocomplete stored variable names for rm command.""" return [name for name in self.context.stored_data if name.startswith(text)] - def do_cls(self, _line): + def do_cls(self, _line) -> None: """Clear stored data.""" self.context.stored_data.clear() self.context.stored_metadata.clear() diff --git a/onvif/cli/interactive/service.py b/onvif/cli/interactive/service.py index 9092de5d..99669463 100644 --- a/onvif/cli/interactive/service.py +++ b/onvif/cli/interactive/service.py @@ -1,5 +1,7 @@ """Service commands implementation.""" +from __future__ import annotations + import cmd import textwrap import traceback @@ -31,7 +33,7 @@ class ServiceCommands(cmd.Cmd): _handle_connection_error: Callable[..., None] _split_multi_commands: Callable[[str], list] - def execute_service_method(self, method_name, params_str): + def execute_service_method(self, method_name: str, params_str: str) -> None: """Execute a method on the current service.""" if not self.context.current_service: print(f"{colorize('Error:', 'red')} Not in service mode") @@ -50,7 +52,7 @@ def execute_service_method(self, method_name, params_str): ) if len(available_methods) > 5: print( - f"Type {colorize('ls', 'cyan')}/press " + f"Type {colorize('ls', 'cyan')} or press " f"{colorize('', 'yellow')} to see all available methods" ) return @@ -90,7 +92,7 @@ def execute_service_method(self, method_name, params_str): if not is_soap_fault and not isinstance(e, TypeError): traceback.print_exc() - def do_desc(self, line): + def do_desc(self, line) -> None: """Describes a method from its WSDL documentation. Usage: desc @@ -145,15 +147,8 @@ def do_desc(self, line): f"No documentation or parameter info found for method '{method_name}'." ) - def complete_desc(self, text, _line, _begidx, _endidx): - """Autocomplete method names for desc command.""" - if not self.context.current_service: - return [] - methods = get_service_methods(self.context.current_service) - return [m for m in methods if m.lower().startswith(text.lower())] - # pylint: disable=too-many-branches,too-many-statements - def do_type(self, line): + def do_type(self, line) -> None: """Show input and output types for a method. Usage: type @@ -317,7 +312,14 @@ def display_params(params, prefix_lines=None, is_root_level=False): f"Could not retrieve type information for '{method_name}'." ) - def complete_type(self, text, _line, _begidx, _endidx): + def complete_desc(self, text, _line, _begidx, _endidx) -> list: + """Autocomplete method names for desc command.""" + if not self.context.current_service: + return [] + methods = get_service_methods(self.context.current_service) + return [m for m in methods if m.lower().startswith(text.lower())] + + def complete_type(self, text, _line, _begidx, _endidx) -> list: """Autocomplete method names for type command.""" if not self.context.current_service: return [] diff --git a/onvif/cli/interactive/shell.py b/onvif/cli/interactive/shell.py index b04d18e6..390ae670 100644 --- a/onvif/cli/interactive/shell.py +++ b/onvif/cli/interactive/shell.py @@ -1,8 +1,12 @@ """ONVIF Interactive Shelll implementation.""" +from __future__ import annotations + import cmd import sys +from argparse import Namespace from datetime import date +from typing import Literal from requests.exceptions import RequestException from zeep.exceptions import TransportError @@ -20,6 +24,8 @@ from .service import ServiceCommands from .utils import ShellUtilities +MODERN_VERSION_MAJOR = 16 + class InteractiveShell( ShellUtilities, @@ -31,11 +37,13 @@ class InteractiveShell( ): """Interactive ONVIF CLI shell.""" - def __init__(self, client: ONVIFClient, args): + def __init__( + self, client: ONVIFClient, args: Namespace, device_data: dict[str, str] + ): cmd.Cmd.__init__(self) self.context = ShellContext(client=client, args=args) - self.device_data = None + self.device_data = device_data self._initialize_health_check() self._initialize_readline() @@ -78,7 +86,7 @@ def _initialize_readline(self) -> None: def _initialize_device_information(self) -> None: """Retrieve and format device information.""" - device_info = self._get_device_information() + device_info = self._format_device_information(self.device_data) onvif_version = self._get_onvif_version() self.context.device_info_text = ( @@ -91,23 +99,17 @@ def _initialize_device_information(self) -> None: f" ONVIF Version : {colorize(onvif_version, 'white')}" ) - def _get_device_information(self) -> dict[str, str]: - """Retrieve basic device information.""" + def _format_device_information(self, device_data: dict[str, str]) -> dict[str, str]: + """Format basic device information.""" try: - self.device_data = self.context.client.devicemgmt().GetDeviceInformation() - return { - "manufacturer": getattr(self.device_data, "Manufacturer", "Unknown"), - "model": getattr(self.device_data, "Model", "Unknown"), - "firmware": getattr(self.device_data, "FirmwareVersion", "Unknown"), - "serial": getattr(self.device_data, "SerialNumber", "Unknown"), - "hardware_id": getattr(self.device_data, "HardwareId", "Unknown"), + "manufacturer": device_data.get("Manufacturer", "Unknown"), + "model": device_data.get("Model", "Unknown"), + "firmware": device_data.get("FirmwareVersion", "Unknown"), + "serial": device_data.get("SerialNumber", "Unknown"), + "hardware_id": device_data.get("HardwareId", "Unknown"), } - except (ONVIFOperationException, KeyError, AttributeError) as e: - if isinstance(e, ONVIFOperationException): - if isinstance(e.original_exception, (RequestException, TransportError)): - self._handle_connection_error() - + except (KeyError, ValueError): return { "manufacturer": "Unknown", "model": "Unknown", @@ -122,7 +124,7 @@ def _get_onvif_version(self) -> str: supported_versions = self.context.client.devicemgmt().GetCapabilities( Category="All" )["Device"]["System"]["SupportedVersions"] - except (ONVIFOperationException, KeyError, AttributeError) as e: + except (ONVIFOperationException, KeyError, AttributeError, TypeError) as e: if isinstance(e, ONVIFOperationException): if isinstance(e.original_exception, (RequestException, TransportError)): self._handle_connection_error() @@ -149,8 +151,7 @@ def _get_onvif_version(self) -> str: if minor is None: return str(major) - version_key = (major, minor) - release_date = ONVIF_VERSION_MAP.get(version_key) + release_date = self._get_version_release_date(major, minor) version = f"{major}.{minor:02d}" @@ -162,18 +163,23 @@ def _get_onvif_version(self) -> str: return version + def _get_version_release_date(self, major: int, minor: int) -> date | None: + """Return the release date for an ONVIF version.""" + if major >= MODERN_VERSION_MAJOR and 1 <= minor <= 12: + return date(2000 + major, minor, 1) + + return ONVIF_VERSION_MAP.get((major, minor)) + def _is_latest_released_version(self, release_date: date) -> bool: - """Return whether the release date is the latest released ONVIF version.""" + """Return whether the ONVIF version is the latest released version.""" today = date.today() - latest_release = max( - ( - version_date - for version_date in ONVIF_VERSION_MAP.values() - if version_date <= today - ), - default=None, - ) + if today.month == 12: + latest_release = date(today.year, 12, 1) + elif today.month >= 6: + latest_release = date(today.year, 6, 1) + else: + latest_release = date(today.year - 1, 12, 1) return release_date == latest_release @@ -238,7 +244,7 @@ def onecmd(self, line): return super().onecmd(line) def default(self, line): - """Handle unknown commands.""" + """Override default to Handle unknown commands.""" available_services = get_device_available_services(self.context.client) # Check if it's a service call (with or without arguments) @@ -275,22 +281,22 @@ def default(self, line): return None def emptyline(self): - """Handle empty line.""" + """Override emptyline to handle empty line.""" - def do_clear(self, _line): + def do_clear(self, _line) -> None: """Clear terminal screen.""" if sys.platform == "win32": print("\033[2J\033[3J\033[H", end="") else: print("\033[2J\033[H", end="") - def do_exit(self, _line): + def do_exit(self, _line) -> Literal[True]: """Exit the shell.""" self.stop_health_check.set() print(colorize("Goodbye!", "cyan")) return True - def run(self): + def run(self) -> None: """Run the interactive shell.""" try: self.cmdloop() diff --git a/onvif/cli/interactive/utils.py b/onvif/cli/interactive/utils.py index 031cb929..89cb4193 100644 --- a/onvif/cli/interactive/utils.py +++ b/onvif/cli/interactive/utils.py @@ -1,5 +1,7 @@ """ONVIF Interactive Shell utilities.""" +from __future__ import annotations + import os import shutil import socket @@ -25,25 +27,29 @@ class ShellUtilities: stop_health_check: threading.Event health_check_thread: threading.Thread - def _initialize_health_check(self): + def _initialize_health_check(self) -> None: """Initialize the background health check.""" self.stop_health_check = threading.Event() self.health_check_thread = threading.Thread( target=self._periodic_health_check, daemon=True ) - def update_prompt(self): + def update_prompt(self) -> None: """Update command prompt based on current context.""" if self.context.current_service_name: self.prompt = ( - f"{self.context.args.username}@{self.context.args.host}:{self.context.args.port}" + f"{self.context.args.username}@{self.context.args.host}" + f":{self.context.args.port}" f"/{self.context.current_service_name} > " ) else: - self.prompt = f"{self.context.args.username}@{self.context.args.host}:{self.context.args.port} > " + self.prompt = ( + f"{self.context.args.username}@{self.context.args.host}" + f":{self.context.args.port} > " + ) # pylint: disable=too-many-locals - def _display_grid(self, items): + def _display_grid(self, items: list): """Display items in grid format matching TAB completion (vertical layout)""" if not items: return @@ -116,8 +122,7 @@ def print_topics(self, header, cmds, _cmdlen, _maxcol): # Print without header if it's empty or whitespace if header.strip(): - # pylint: disable=no-member - self.stdout.write(f"{header}\n") + print(f"{header}\n") # Use our grid display for TAB completion with coloring enabled self._display_grid(cmds) @@ -151,8 +156,8 @@ def get_suggestions(self, partial_cmd: str) -> list[str]: return suggestions[:5] # Limit to 5 suggestions - def completenames(self, text: str, *_ignored) -> list[str]: - """Tab completion for command names.""" + def completenames(self, text: str, *_ignored): + """Override completenames for tab completion from command names.""" if self.context.current_service: # Complete method names in service mode methods = get_service_methods(self.context.current_service) @@ -174,7 +179,7 @@ def completenames(self, text: str, *_ignored) -> list[str]: return completions - def _periodic_health_check(self): + def _periodic_health_check(self) -> None: """Periodically checks device connection using TCP or TLS depending on mode.""" # Get health check interval from args, default to 10 seconds health_check_interval = getattr(self.context.args, "health_check_interval", 10) @@ -183,7 +188,7 @@ def _periodic_health_check(self): self.stop_health_check.wait(health_check_interval) while not self.stop_health_check.is_set(): - sock = None + sock: socket.socket | None = None try: # For HTTPS, use ssl.create_connection for proper TLS handling if getattr(self.context.args, "https", False): @@ -238,7 +243,7 @@ def _periodic_health_check(self): # Wait before next check or stop signal self.stop_health_check.wait(health_check_interval) - def _handle_connection_error(self): + def _handle_connection_error(self) -> None: """Handle connection errors by notifying the user and exiting.""" print(f"\n{colorize('Connection to device lost.', 'red')}", file=sys.stderr) # print(f"{colorize('Error:', 'red')} {e}", file=sys.stderr) diff --git a/onvif/cli/main.py b/onvif/cli/main.py index 7f916f9e..fa5a3fe3 100644 --- a/onvif/cli/main.py +++ b/onvif/cli/main.py @@ -5,7 +5,7 @@ import getpass import sys import traceback as traceback_lib -from argparse import ArgumentParser, RawDescriptionHelpFormatter +from argparse import ArgumentParser, Namespace, RawDescriptionHelpFormatter from onvif.cli.helpers import ( discover_devices, @@ -19,7 +19,7 @@ from onvif.cli.interactive import InteractiveShell from onvif.cli.utils import colorize from onvif.client import ONVIFClient -from onvif.meta import __repository__, __version__ +from onvif.meta import __repository__, __terminal_name__, __version__ from onvif.operator import CacheMode from onvif.utils import ONVIFOperationException @@ -28,7 +28,10 @@ def _create_parser() -> ArgumentParser: """Create argument parser for ONVIF CLI.""" parser = ArgumentParser( prog="onvif", - description=f"{colorize('ONVIF Terminal Client', 'yellow')} — v{__version__}\n{__repository__}", + description=( + f"{colorize(__terminal_name__, 'yellow')} — " + f"v{__version__}\n{__repository__}" + ), formatter_class=RawDescriptionHelpFormatter, epilog=CLI_EPILOG, ) @@ -163,7 +166,7 @@ def _create_parser() -> ArgumentParser: return parser -def _handle_discovery_mode(parser, args) -> None: +def _handle_discovery_mode(parser: ArgumentParser, args: Namespace) -> None: """Handle discovery mode.""" if args.discover: if args.host: @@ -199,7 +202,7 @@ def _handle_discovery_mode(parser, args) -> None: args.host, args.port, _ = selected -def _handle_authentication(args) -> None: +def _handle_authentication(args: Namespace) -> None: """Handle auth prompt.""" # Handle username prompt (skip for search mode) if not args.search and not args.username: @@ -220,7 +223,7 @@ def _handle_authentication(args) -> None: sys.exit(1) -def _process_onvif_client(args) -> None: +def _process_onvif_client(args: Namespace) -> None: """Process ONVIFClient initialization.""" # Skip ONVIF client creation for search mode if args.search: @@ -252,7 +255,8 @@ def _process_onvif_client(args) -> None: # Test connection before starting interactive shell try: # Try to get device information to verify connection - client.devicemgmt().GetDeviceInformation() + device = client.devicemgmt() + device_data = device.to_dict(device.GetDeviceInformation()) except ONVIFOperationException as e: print( f"{colorize('Error:', 'red')} Unable to connect to ONVIF device at " @@ -265,7 +269,7 @@ def _process_onvif_client(args) -> None: sys.exit(1) # Start interactive shell - shell = InteractiveShell(client, args) + shell = InteractiveShell(client=client, args=args, device_data=device_data) shell.run() else: # Execute direct command diff --git a/onvif/cli/utils.py b/onvif/cli/utils.py index a1fb98e8..4f9f0dcb 100644 --- a/onvif/cli/utils.py +++ b/onvif/cli/utils.py @@ -151,7 +151,7 @@ def get_service_required_args(service_name: str) -> list[str] | None: return None -def get_service_methods(service_obj) -> list: +def get_service_methods(service_obj: object) -> list: """Get list of available methods for a service.""" methods = [] for attr_name in dir(service_obj): @@ -211,7 +211,7 @@ def colorize(text: str, color: str) -> str: def format_capabilities_as_services(capabilities) -> str: - """Format capabilities response as service list with XAddr.""" + """Format GetCapabilities response as service list with XAddr.""" services = [] # Map of capability names to service function names @@ -289,7 +289,7 @@ def format_capabilities_as_services(capabilities) -> str: return f"{colorize('No services found in capabilities', 'yellow')}" -def format_services_list(services_list) -> str: +def format_services_list(services_list: list) -> str: """Format GetServices response as service list with XAddr and binding support. Shows binding information for all services (single and multi-binding). diff --git a/onvif/mappings.py b/onvif/mappings.py index e7249350..3d0197be 100644 --- a/onvif/mappings.py +++ b/onvif/mappings.py @@ -380,6 +380,7 @@ class WSDLDefinition(TypedDict): } ONVIF_VERSION_MAP: Final[dict[tuple[int, int], date]] = { + # 2008–2015 only (1, 0): date(2008, 11, 1), (1, 10): date(2009, 7, 1), (1, 20): date(2010, 6, 1), @@ -395,25 +396,5 @@ class WSDLDefinition(TypedDict): (2, 50): date(2014, 12, 1), (2, 60): date(2015, 6, 1), (2, 61): date(2015, 12, 1), - (16, 6): date(2016, 6, 1), - (16, 12): date(2016, 12, 1), - (17, 6): date(2017, 6, 1), - (17, 12): date(2017, 12, 1), - (18, 6): date(2018, 6, 1), - (18, 12): date(2018, 12, 1), - (19, 6): date(2019, 6, 1), - (19, 12): date(2019, 12, 1), - (20, 6): date(2020, 6, 1), - (20, 12): date(2020, 12, 1), - (21, 6): date(2021, 6, 1), - (21, 12): date(2021, 12, 1), - (22, 6): date(2022, 6, 1), - (22, 12): date(2022, 12, 1), - (23, 6): date(2023, 6, 1), - (23, 12): date(2023, 12, 1), - (24, 6): date(2024, 6, 1), - (24, 12): date(2024, 12, 1), - (25, 6): date(2025, 6, 1), - (25, 12): date(2025, 12, 1), - (26, 6): date(2026, 6, 1), + # Modern version (2016 +) will use the {Year}.{Month} format. } diff --git a/onvif/meta.py b/onvif/meta.py index 54d6c876..d4b09e4d 100644 --- a/onvif/meta.py +++ b/onvif/meta.py @@ -4,3 +4,6 @@ __version__: Final[str] = "0.4.4" __repository__: Final[str] = "https://github.com/nirsimetri/onvif-python" + +__terminal_name__: Final[str] = "ONVIF Terminal Client" +__interactive_name__: Final[str] = "ONVIF Interactive Shell" diff --git a/tests/cli/test_cli_interactive_shell.py b/tests/cli/test_cli_interactive_shell.py index 1fe213a8..48da7431 100644 --- a/tests/cli/test_cli_interactive_shell.py +++ b/tests/cli/test_cli_interactive_shell.py @@ -2,6 +2,7 @@ """Tests for the ONVIF interactive shell.""" import cmd +from datetime import date from types import SimpleNamespace from unittest.mock import MagicMock, patch @@ -11,6 +12,8 @@ from onvif.cli.interactive.shell import InteractiveShell from onvif.utils.exceptions import ONVIFOperationException +from .conftest import strip_ansi + def create_args(**overrides): """Create mocked CLI arguments.""" @@ -65,6 +68,18 @@ def create_client(): return client +def create_device_data(): + """Create device information data as dict.""" + + return { + "Manufacturer": "Dahua", + "Model": "DH-H5D-5F", + "FirmwareVersion": "2.860.0000000.26.R", + "SerialNumber": "AM08C90PAG3C79B", + "HardwareId": "1.00", + } + + class TestInteractiveShellInitialization: """Test initialization and startup behavior of ``InteractiveShell``.""" @@ -78,44 +93,53 @@ def args(self): """Provide default CLI arguments for initialization tests.""" return create_args() + @pytest.fixture + def device_data(self): + """Provide default device info for initialization tests.""" + return create_device_data() + @staticmethod - def _create_shell(client, args): + def _create_shell(client, args, device_data): with patch("onvif.cli.interactive.utils.threading.Thread"): - return InteractiveShell(client, args) + return InteractiveShell(client, args, device_data) - def test_initializes_context(self, client, args): + def test_initializes_context(self, client, args, device_data): """Verify that initialization creates the shared shell context.""" - shell = self._create_shell(client, args) + shell = self._create_shell(client, args, device_data) assert shell.context.client is client assert shell.context.args is args - def test_initializes_cmd_state(self, client, args): + def test_initializes_cmd_state(self, client, args, device_data): """Verify that ``cmd.Cmd`` state is initialized.""" - shell = self._create_shell(client, args) + shell = self._create_shell(client, args, device_data) assert hasattr(shell, "stdin") assert hasattr(shell, "stdout") assert hasattr(shell, "cmdqueue") assert shell.prompt.endswith("> ") - def test_fetches_device_information(self, client, args): - """Verify that device information is requested during initialization.""" - self._create_shell(client, args) + def test_uses_provided_device_information(self, client, args, device_data): + """Verify that provided device information is used during initialization.""" + shell = self._create_shell(client, args, device_data) - client.devicemgmt.return_value.GetDeviceInformation.assert_called_once_with() + assert "Dahua" in shell.context.device_info_text + assert "DH-H5D-5F" in shell.context.device_info_text + assert "2.860.0000000.26.R" in shell.context.device_info_text + assert "AM08C90PAG3C79B" in shell.context.device_info_text + assert "1.00" in shell.context.device_info_text - def test_fetches_supported_onvif_versions(self, client, args): + def test_fetches_supported_onvif_versions(self, client, args, device_data): """Verify that supported ONVIF versions are requested during initialization.""" - self._create_shell(client, args) + self._create_shell(client, args, device_data) client.devicemgmt.return_value.GetCapabilities.assert_called_once_with( Category="All" ) - def test_builds_device_information_text(self, client, args): + def test_builds_device_information_text(self, client, args, device_data): """Verify that device information is formatted into the shell context.""" - shell = self._create_shell(client, args) + shell = self._create_shell(client, args, device_data) assert shell.context.device_info_text is not None assert "Dahua" in shell.context.device_info_text @@ -125,13 +149,13 @@ def test_builds_device_information_text(self, client, args): assert "1.00" in shell.context.device_info_text assert "2.06" in shell.context.device_info_text - def test_prints_intro_with_device_information(self, client, args): + def test_prints_intro_with_device_information(self, client, args, device_data): """Verify that the interactive intro receives formatted device information.""" with patch( "onvif.cli.interactive.shell.print_interactive_intro", return_value="Interactive ONVIF shell", ) as print_intro: - shell = self._create_shell(client, args) + shell = self._create_shell(client, args, device_data) print_intro.assert_called_once_with( args, @@ -139,22 +163,22 @@ def test_prints_intro_with_device_information(self, client, args): ) assert shell.intro == "Interactive ONVIF shell" - def test_starts_health_check_after_initialization(self, client, args): + def test_starts_health_check_after_initialization(self, client, args, device_data): """Verify that the background health-check thread starts after initialization.""" with patch("onvif.cli.interactive.utils.threading.Thread") as thread_cls: health_thread = thread_cls.return_value - InteractiveShell(client, args) + InteractiveShell(client, args, device_data) health_thread.start.assert_called_once_with() - def test_handles_missing_capabilities(self, client, args): + def test_handles_missing_capabilities(self, client, args, device_data): """Verify that initialization continues when capability data is unavailable.""" client.devicemgmt.return_value.GetCapabilities.side_effect = KeyError( "SupportedVersions" ) - shell = self._create_shell(client, args) + shell = self._create_shell(client, args, device_data) assert shell.context.device_info_text is not None assert "Dahua" in shell.context.device_info_text @@ -162,37 +186,383 @@ def test_handles_missing_capabilities(self, client, args): def test_handles_missing_device_attributes(self, client, args): """Verify that missing device attributes fall back to ``Unknown``.""" - client.devicemgmt.return_value.GetDeviceInformation.return_value = ( - SimpleNamespace() + device_data = {} + + shell = self._create_shell(client, args, device_data) + + output = strip_ansi(shell.context.device_info_text) + + assert "Manufacturer : Unknown" in output + assert "Model : Unknown" in output + assert "Firmware : Unknown" in output + assert "Serial : Unknown" in output + assert "HardwareId : Unknown" in output + + def test_handles_connection_error(self, client, args, device_data): + """Verify that transport-related ONVIF errors invoke connection handling.""" + original_exception = RequestException("Connection failed") + + client.devicemgmt.return_value.GetCapabilities.side_effect = ( + ONVIFOperationException( + "Connection failed", + original_exception=original_exception, + ) ) - shell = self._create_shell(client, args) + with patch.object( + InteractiveShell, + "_handle_connection_error", + ) as handle_connection_error: + shell = self._create_shell(client, args, device_data) + handle_connection_error.assert_called_once_with() + assert "ONVIF Version" in shell.context.device_info_text assert "Unknown" in shell.context.device_info_text - def test_handles_connection_error(self, client, args): - """Verify that transport-related ONVIF errors invoke connection handling.""" - original_exception = MagicMock() + +class TestInteractiveShellDeviceInformation: + """Test device information formatting.""" + + def test_formats_complete_device_information(self): + """Verify that all device information fields are formatted.""" + shell = object.__new__(InteractiveShell) + + device_data = { + "Manufacturer": "Dahua", + "Model": "DH-H5D-5F", + "FirmwareVersion": "2.860", + "SerialNumber": "ABC123", + "HardwareId": "1.00", + } + + result = shell._format_device_information(device_data) + + assert result == { + "manufacturer": "Dahua", + "model": "DH-H5D-5F", + "firmware": "2.860", + "serial": "ABC123", + "hardware_id": "1.00", + } + + def test_formats_missing_device_information(self): + """Verify that missing fields fall back to ``Unknown``.""" + shell = object.__new__(InteractiveShell) + + result = shell._format_device_information({}) + + assert result == { + "manufacturer": "Unknown", + "model": "Unknown", + "firmware": "Unknown", + "serial": "Unknown", + "hardware_id": "Unknown", + } + + def test_handles_invalid_device_information(self): + """Verify that invalid device data falls back to ``Unknown``.""" + shell = object.__new__(InteractiveShell) + + class InvalidDeviceData: # pylint: disable=too-few-public-methods + """Device data that raises an error when accessed.""" + + def get(self, _key, _default): + """ "Get invalid device data.""" + raise ValueError("Invalid device data") + + result = shell._format_device_information(InvalidDeviceData()) + + assert result == { + "manufacturer": "Unknown", + "model": "Unknown", + "firmware": "Unknown", + "serial": "Unknown", + "hardware_id": "Unknown", + } + + +class TestInteractiveShellONVIFVersion: + """Test ONVIF version detection and formatting.""" + + @staticmethod + def _create_shell(client): + shell = object.__new__(InteractiveShell) + shell.context = MagicMock() + shell.context.client = client + return shell + + def test_returns_unknown_when_capabilities_raise_onvif_error(self): + """Verify that ONVIF operation errors return ``Unknown``.""" + client = MagicMock() + client.devicemgmt.return_value.GetCapabilities.side_effect = ( + ONVIFOperationException( + "Failed to get capabilities", RuntimeError("Failed") + ) + ) + + shell = self._create_shell(client) + + assert shell._get_onvif_version() == "Unknown" + + def test_handles_transport_error_from_onvif_error(self): + """Verify that transport errors invoke connection handling.""" + client = MagicMock() original_exception = RequestException("Connection failed") - client.devicemgmt.return_value.GetDeviceInformation.side_effect = ( + client.devicemgmt.return_value.GetCapabilities.side_effect = ( ONVIFOperationException( - "Connection failed", + "Failed to get capabilities", original_exception=original_exception, ) ) - with ( - patch.object( - InteractiveShell, - "_handle_connection_error", - ) as handle_connection_error, - ): - self._create_shell(client, args) + shell = self._create_shell(client) + with patch.object( + shell, + "_handle_connection_error", + ) as handle_connection_error: + result = shell._get_onvif_version() + + assert result == "Unknown" handle_connection_error.assert_called_once_with() + def test_returns_unknown_for_empty_supported_versions(self): + """Verify that an empty version list returns ``Unknown``.""" + client = MagicMock() + client.devicemgmt.return_value.GetCapabilities.return_value = { + "Device": { + "System": { + "SupportedVersions": [], + } + } + } + + shell = self._create_shell(client) + + assert shell._get_onvif_version() == "Unknown" + + def test_formats_version_without_minor(self): + """Verify that versions without a minor component use the major version.""" + client = MagicMock() + client.devicemgmt.return_value.GetCapabilities.return_value = { + "Device": { + "System": { + "SupportedVersions": [ + SimpleNamespace(Major=3, Minor=None), + ] + } + } + } + + shell = self._create_shell(client) + + assert shell._get_onvif_version() == "3" + + def test_returns_unknown_when_major_is_missing(self): + """Verify that a version without a major component returns ``Unknown``.""" + client = MagicMock() + client.devicemgmt.return_value.GetCapabilities.return_value = { + "Device": { + "System": { + "SupportedVersions": [ + SimpleNamespace(Major=None, Minor=5), + ] + } + } + } + + shell = self._create_shell(client) + + assert shell._get_onvif_version() == "Unknown" + + def test_formats_version_with_release_date(self): + """Verify that a known ONVIF version includes its release date.""" + client = MagicMock() + client.devicemgmt.return_value.GetCapabilities.return_value = { + "Device": { + "System": { + "SupportedVersions": [ + SimpleNamespace(Major=2, Minor=60), + ] + } + } + } + + shell = self._create_shell(client) + + with patch.object( + shell, + "_is_latest_released_version", + return_value=False, + ): + result = shell._get_onvif_version() + + assert result.startswith("2.60 (") + assert "[Latest]" not in result + + def test_formats_latest_version(self): + """Verify that the latest released version includes the latest marker.""" + client = MagicMock() + client.devicemgmt.return_value.GetCapabilities.return_value = { + "Device": { + "System": { + "SupportedVersions": [ + SimpleNamespace(Major=2, Minor=60), + ] + } + } + } + + shell = self._create_shell(client) + + with patch.object( + shell, + "_is_latest_released_version", + return_value=True, + ): + result = shell._get_onvif_version() + + assert result.startswith("2.60 (") + assert "[Latest]" in result + + def test_formats_unknown_version_without_release_date(self): + """Verify that an unknown ONVIF version has no release-date suffix.""" + client = MagicMock() + client.devicemgmt.return_value.GetCapabilities.return_value = { + "Device": { + "System": { + "SupportedVersions": [ + SimpleNamespace(Major=9, Minor=99), + ] + } + } + } + + shell = self._create_shell(client) + + assert shell._get_onvif_version() == "9.99" + + def test_selects_highest_supported_version(self): + """Verify that the highest major/minor version is selected.""" + client = MagicMock() + client.devicemgmt.return_value.GetCapabilities.return_value = { + "Device": { + "System": { + "SupportedVersions": [ + SimpleNamespace(Major=2, Minor=0), + SimpleNamespace(Major=1, Minor=99), + SimpleNamespace(Major=2, Minor=6), + SimpleNamespace(Major=2, Minor=5), + ] + } + } + } + + shell = self._create_shell(client) + + with patch.object( + shell, + "_is_latest_released_version", + return_value=False, + ): + result = shell._get_onvif_version() + + assert result.startswith("2.06") + + +class TestInteractiveShellLatestVersion: + """Test latest released ONVIF version detection.""" + + def test_returns_true_for_latest_released_version(self): + """Verify that the latest released version is detected.""" + shell = object.__new__(InteractiveShell) + + with patch( + "onvif.cli.interactive.shell.date", + wraps=date, + ) as mock_date: + mock_date.today.return_value = date(2026, 10, 6) + + assert shell._is_latest_released_version(date(2026, 6, 1)) + + def test_returns_false_for_older_released_version(self): + """Verify that an older released version is not considered latest.""" + shell = object.__new__(InteractiveShell) + + with patch( + "onvif.cli.interactive.shell.ONVIF_VERSION_MAP", + { + (2, 5): date(2025, 1, 1), + (2, 6): date(2026, 6, 1), + }, + ): + with patch("onvif.cli.interactive.shell.date") as mock_date: + mock_date.today.return_value = date(2026, 10, 6) + + assert not shell._is_latest_released_version(date(2025, 1, 1)) + + def test_returns_false_for_future_release(self): + """Verify that a future release is not considered the latest.""" + shell = object.__new__(InteractiveShell) + + with patch("onvif.cli.interactive.shell.date") as mock_date: + mock_date.today.return_value = date(2026, 10, 6) + + assert not shell._is_latest_released_version(date(2026, 12, 1)) + + def test_returns_false_when_no_version_has_been_released(self): + """Verify that no released versions results in ``False``.""" + shell = object.__new__(InteractiveShell) + + with patch( + "onvif.cli.interactive.shell.ONVIF_VERSION_MAP", + { + (2, 7): date(2027, 1, 1), + }, + ): + with patch("onvif.cli.interactive.shell.date") as mock_date: + mock_date.today.return_value = date(2026, 10, 6) + + assert not shell._is_latest_released_version(date(2027, 1, 1)) + + def test_returns_true_for_december_release(self): + """Verify that the December release is latest in December.""" + shell = object.__new__(InteractiveShell) + + with patch( + "onvif.cli.interactive.shell.date", + wraps=date, + ) as mock_date: + mock_date.today.return_value = date(2026, 12, 1) + + assert shell._is_latest_released_version(date(2026, 12, 1)) + + def test_returns_true_for_june_release(self): + """Verify that the June release is latest from June through November.""" + shell = object.__new__(InteractiveShell) + + with patch( + "onvif.cli.interactive.shell.date", + wraps=date, + ) as mock_date: + mock_date.today.return_value = date(2026, 10, 6) + + assert shell._is_latest_released_version(date(2026, 6, 1)) + + def test_returns_true_for_previous_december_release(self): + """Verify that the previous December release is latest before June.""" + shell = object.__new__(InteractiveShell) + + with patch( + "onvif.cli.interactive.shell.date", + wraps=date, + ) as mock_date: + mock_date.today.return_value = date(2026, 3, 1) + + assert shell._is_latest_released_version(date(2025, 12, 1)) + class TestInteractiveShellPrompt: """Test prompt management for ``InteractiveShell``.""" diff --git a/tests/cli/test_cli_interactive_utils.py b/tests/cli/test_cli_interactive_utils.py index 0575a351..2524b776 100644 --- a/tests/cli/test_cli_interactive_utils.py +++ b/tests/cli/test_cli_interactive_utils.py @@ -281,14 +281,16 @@ def test_print_topics_returns_for_empty_commands(self): display_grid.assert_not_called() assert result is None - def test_print_topics_writes_nonempty_header(self): - """Verify that a nonempty header is written to stdout.""" + def test_print_topics_writes_nonempty_header(self, capsys): + """Verify that a nonempty header is printed to stdout.""" utilities = create_utilities() with patch.object(utilities, "_display_grid") as display_grid: utilities.print_topics("Commands", ["help", "exit"], 10, 2) - utilities.stdout.write.assert_called_once_with("Commands\n") + captured = capsys.readouterr() + + assert captured.out == "Commands\n\n" display_grid.assert_called_once_with(["help", "exit"]) def test_print_topics_ignores_whitespace_header(self): @@ -585,10 +587,11 @@ def test_successful_https_health_check(self): ssl_context.wrap_socket.return_value = tls_socket with ( + # pylint: disable=redefined-outer-name patch( "onvif.cli.interactive.utils.ssl.create_default_context", return_value=ssl_context, - ) as create_context, # pylint: disable=redefined-outer-name + ) as create_context, patch( "onvif.cli.interactive.utils.socket.socket", return_value=raw_socket, diff --git a/tests/cli/test_cli_main.py b/tests/cli/test_cli_main.py index 42dd7774..6c5a8cab 100644 --- a/tests/cli/test_cli_main.py +++ b/tests/cli/test_cli_main.py @@ -465,6 +465,20 @@ def test_interactive(self): ) client = Mock() + device = Mock() + device_info = Mock() + + device_data = { + "Manufacturer": "Dahua", + "Model": "DH-H5D-5F", + "FirmwareVersion": "2.860.0000000.26.R", + "SerialNumber": "AM08C90PAG3C79B", + "HardwareId": "1.00", + } + + client.devicemgmt.return_value = device + device.GetDeviceInformation.return_value = device_info + device.to_dict.return_value = device_data with ( patch( @@ -477,9 +491,16 @@ def test_interactive(self): ): _process_onvif_client(args) - client.devicemgmt().GetDeviceInformation.assert_called_once() - mock_shell.assert_called_once_with(client, args) - mock_shell.return_value.run.assert_called_once() + client.devicemgmt.assert_called_once_with() + device.GetDeviceInformation.assert_called_once_with() + device.to_dict.assert_called_once_with(device_info) + + mock_shell.assert_called_once_with( + client=client, + args=args, + device_data=device_data, + ) + mock_shell.return_value.run.assert_called_once_with() def test_connection_error(self): """Test interactive mode when the ONVIF connection fails.""" From b64667ba7cfe6dc980d63b65dc43f2328f10381e Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Wed, 7 Oct 2026 00:27:53 +0700 Subject: [PATCH 06/37] feat(docs): Enhance docs with icons for external links (#160) --- docs/core/onvif_cli.md | 4 ---- docs/index.md | 18 +++++++++--------- docs/javascripts/external-links.js | 26 ++++++++++++++++++++++++-- docs/project/roadmap.md | 2 +- docs/project/used_by.md | 2 +- docs/stylesheets/extra.css | 18 ++++++++++++++++++ 6 files changed, 53 insertions(+), 17 deletions(-) diff --git a/docs/core/onvif_cli.md b/docs/core/onvif_cli.md index 9610b24a..c46e173a 100644 --- a/docs/core/onvif_cli.md +++ b/docs/core/onvif_cli.md @@ -25,14 +25,10 @@ This library includes a powerful command-line interface (CLI) for interacting wi diff --git a/docs/index.md b/docs/index.md index cc98db0f..424bed7d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,19 +1,19 @@ # ONVIF Python -[![Python Version](https://img.shields.io/pypi/pyversions/onvif-python?logo=python&logoColor=white&color=blue&style=plastic&label=Python)](https://pypi.org/project/onvif-python) -[![PyPI Version](https://img.shields.io/pypi/v/onvif-python?logo=pypi&logoColor=white&color=blue&style=plastic&label=PyPI)](https://pypi.org/project/onvif-python/) -[![Quality](https://img.shields.io/codacy/grade/bff08a94e4d447b690cea49c6594826d?style=plastic&logo=codacy&label=Quality)](https://app.codacy.com/gh/nirsimetri/onvif-python/dashboard) -[![Coverage](https://img.shields.io/codacy/coverage/bff08a94e4d447b690cea49c6594826d?style=plastic&logo=codacy&label=Coverage)](https://app.codacy.com/gh/nirsimetri/onvif-python/coverage) -[![Downloads](https://img.shields.io/pepy/dt/onvif-python?label=Downloads&color=red&style=plastic)](https://pepy.tech/projects/onvif-python) +[![Python Version](https://img.shields.io/pypi/pyversions/onvif-python?logo=python&logoColor=white&color=blue&style=plastic&label=Python)](https://pypi.org/project/onvif-python){ .no-external-icon } +[![PyPI Version](https://img.shields.io/pypi/v/onvif-python?logo=pypi&logoColor=white&color=blue&style=plastic&label=PyPI)](https://pypi.org/project/onvif-python/){ .no-external-icon } +[![Quality](https://img.shields.io/codacy/grade/bff08a94e4d447b690cea49c6594826d?style=plastic&logo=codacy&label=Quality)](https://app.codacy.com/gh/nirsimetri/onvif-python/dashboard){ .no-external-icon } +[![Coverage](https://img.shields.io/codacy/coverage/bff08a94e4d447b690cea49c6594826d?style=plastic&logo=codacy&label=Coverage)](https://app.codacy.com/gh/nirsimetri/onvif-python/coverage){ .no-external-icon } +[![Downloads](https://img.shields.io/pepy/dt/onvif-python?label=Downloads&color=red&style=plastic)](https://pepy.tech/projects/onvif-python){ .no-external-icon }
-[![Build](https://img.shields.io/github/actions/workflow/status/nirsimetri/onvif-python/python-app.yml?logo=github&style=plastic&label=Build)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-app.yml) -[![Upload Python](https://img.shields.io/github/actions/workflow/status/nirsimetri/onvif-python/python-publish.yml?logo=github&style=plastic&label=Upload%20Package)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-publish.yml) -[![CLI Cross-Platform](https://img.shields.io/github/actions/workflow/status/nirsimetri/onvif-python/cli-cross-platform.yml?logo=github&style=plastic&label=CLI%20Cross-Platform)](https://github.com/nirsimetri/onvif-python/actions/workflows/cli-cross-platform.yml) +[![Build](https://img.shields.io/github/actions/workflow/status/nirsimetri/onvif-python/python-app.yml?logo=github&style=plastic&label=Build)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-app.yml){ .no-external-icon } +[![Upload Python](https://img.shields.io/github/actions/workflow/status/nirsimetri/onvif-python/python-publish.yml?logo=github&style=plastic&label=Upload%20Package)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-publish.yml){ .no-external-icon } +[![CLI Cross-Platform](https://img.shields.io/github/actions/workflow/status/nirsimetri/onvif-python/cli-cross-platform.yml?logo=github&style=plastic&label=CLI%20Cross-Platform)](https://github.com/nirsimetri/onvif-python/actions/workflows/cli-cross-platform.yml){ .no-external-icon } **[ONVIF](https://www.onvif.org) (Open Network Video Interface Forum)** is a global standard for the interface of IP-based physical security products, including network cameras, video recorders, and related systems. -Behind the scenes, ONVIF communication relies on **[SOAP](https://en.wikipedia.org/wiki/SOAP) (Simple Object Access Protocol)**; an [XML](https://en.wikipedia.org/wiki/XML)-based messaging protocol with strict schema definitions ([WSDL](https://en.wikipedia.org/wiki/Web_Services_Description_Language)/[XSD](https://en.wikipedia.org/wiki/XML_Schema_(W3C))). SOAP ensures interoperability, but when used directly it can be verbose, complex, and error-prone. +Behind the scenes, ONVIF communication relies on **[SOAP](https://en.wikipedia.org/wiki/SOAP) (Simple Object Access Protocol)**; an [XML](https://en.wikipedia.org/wiki/XML)-based messaging protocol with strict schema definitions ([WSDL](https://en.wikipedia.org/wiki/Web_Services_Description_Language) and [XSD](https://en.wikipedia.org/wiki/XML_Schema_(W3C))). SOAP ensures interoperability, but when used directly it can be verbose, complex, and error-prone. This library simplifies that process by wrapping SOAP communication into a clean, Pythonic API. You no longer need to handle low-level XML parsing, namespaces, or security tokens manually; the library takes care of it, letting you focus on building functionality. diff --git a/docs/javascripts/external-links.js b/docs/javascripts/external-links.js index b95614b4..114b96fa 100644 --- a/docs/javascripts/external-links.js +++ b/docs/javascripts/external-links.js @@ -1,10 +1,32 @@ /* global document$ */ document$.subscribe(() => { - document.querySelectorAll('a[href^="http"]').forEach((link) => { - if (link.hostname !== window.location.hostname) { + document.querySelectorAll('.md-content a[href]').forEach((link) => { + const url = new URL(link.href, window.location.href); + + if ( + (url.protocol === "http:" || url.protocol === "https:") && + url.hostname !== window.location.hostname + ) { link.target = "_blank"; link.rel = "noopener noreferrer"; + + if ( + !link.classList.contains("no-external-icon") && + !link.querySelector(".external-link-icon") + ) { + const icon = document.createElement("span"); + icon.className = "external-link-icon"; + icon.setAttribute("aria-hidden", "true"); + + icon.innerHTML = ` + + + + `; + + link.appendChild(icon); + } } }); }); \ No newline at end of file diff --git a/docs/project/roadmap.md b/docs/project/roadmap.md index f803c135..1685a38c 100644 --- a/docs/project/roadmap.md +++ b/docs/project/roadmap.md @@ -1,6 +1,6 @@ ## Stay tuned and star ⭐ this repo -[![GitHub stars](https://img.shields.io/github/stars/nirsimetri/onvif-python?style=social)](https://github.com/nirsimetri/onvif-python) +[![GitHub stars](https://img.shields.io/github/stars/nirsimetri/onvif-python?style=social)](https://github.com/nirsimetri/onvif-python){ .no-external-icon } - [x] Add debugging mode with raw xml on SOAP requests and responses ([`v0.0.6`](../releases.md/#v0.0.6)) - [x] Add functionality for `ONVIFClient` to accept a custom `wsdl_dir` ([`v0.1.0`](../releases.md/#v0.1.0)) diff --git a/docs/project/used_by.md b/docs/project/used_by.md index 49f3f355..4549b535 100644 --- a/docs/project/used_by.md +++ b/docs/project/used_by.md @@ -1,4 +1,4 @@ -With Total Downloads, the `onvif-python` library is already being used by several well-known open-source projects, including: +With Total Downloads, the `onvif-python` library is already being used by several well-known open-source projects, including: ## Viseron diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 1eb76127..89d2efc6 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -30,6 +30,20 @@ display: none; } +.external-link-icon { + display: inline-block; + width: 0.8em; + height: 0.8em; + margin-left: 0.2em; + vertical-align: -0.05em; +} + +.external-link-icon svg { + width: 100%; + height: 100%; + fill: currentColor; +} + .md-content__inner { padding-bottom: 3rem; } @@ -74,6 +88,10 @@ width: 100%; } +.md-content__inner .md-typeset__table a { + white-space: nowrap; +} + /* Scrollbar */ ::-webkit-scrollbar { width: 9px; From 185919d8fb68eff94538ebaefa35b7d5a1964ee7 Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Wed, 7 Oct 2026 16:27:51 +0700 Subject: [PATCH 07/37] feat(discovery): Implement concurrent processing for device discovery and enhance error handling (#161) * Implement concurrent processing for device discovery and enhance error handling * Remove unnecessary assertion from TestDiscoveryConstants --- onvif/utils/discovery.py | 302 ++++++++++++++++-------------- tests/utilities/test_discovery.py | 1 - 2 files changed, 165 insertions(+), 138 deletions(-) diff --git a/onvif/utils/discovery.py b/onvif/utils/discovery.py index a3b2c10e..669708c8 100644 --- a/onvif/utils/discovery.py +++ b/onvif/utils/discovery.py @@ -6,6 +6,7 @@ import socket import struct import uuid +from concurrent.futures import ThreadPoolExecutor from typing import Any, ClassVar from urllib.parse import urlparse @@ -19,6 +20,8 @@ logger = logging.getLogger(__name__) logger.addHandler(logging.NullHandler()) +DEFAULT_MAX_WORKERS = 10 + class ONVIFDiscovery: """Discover ONVIF devices using the WS-Discovery protocol. @@ -54,7 +57,7 @@ class ONVIFDiscovery: "" "" "" - "tds:Device" + "" "" "" "" @@ -102,7 +105,7 @@ def get_local_ip(self) -> str: self._local_ip = s.getsockname()[0] s.close() return self._local_ip - except Exception as e: # pylint: disable=broad-except + except OSError as e: logger.debug("Failed to get local IP via default route: %s", e) # Try alternative method to get local IP try: @@ -112,7 +115,7 @@ def get_local_ip(self) -> str: self._local_ip = local_ip logger.debug("Got local IP via hostname: %s", local_ip) return self._local_ip - except Exception as exc: # pylint: disable=broad-except + except OSError as exc: logger.debug("Failed to get local IP via hostname: %s", exc) # Return empty string instead of None for socket binding @@ -205,7 +208,7 @@ def discover( except socket.timeout: logger.debug("Discovery timeout reached") break - except Exception as exc: # pylint: disable=broad-except + except (OSError, UnicodeError) as exc: # Ignore individual packet errors and continue logger.debug( "Error receiving packet: %s", @@ -215,7 +218,7 @@ def discover( sock.close() - except Exception as exc: # pylint: disable=broad-except + except OSError as exc: # Socket creation or binding failed logger.error("Discovery failed: %s", exc) return [] @@ -242,134 +245,6 @@ def discover( logger.info("Discovery completed: found %s ONVIF devices", len(devices)) return devices - def _process_device( - self, discovered_devices: list[dict[str, Any]] - ) -> list[dict[str, Any]]: - """Enrich discovered devices with unauthenticated device information. - - Connects to each discovered device without authentication and attempts to - retrieve information that is available without credentials, including the - device hostname, system date and time, and supported ONVIF services. - - Devices for which an ONVIF operation fails are skipped and do not prevent - the remaining discovered devices from being processed. - - Args: - discovered_devices: List of device dictionaries returned by the - discovery process. Each device must contain at least the host and - port required to establish an ONVIF connection. - - Returns: - The list of discovered devices enriched with hostname, date/time, and - service information where available. - """ - logger.debug( - "Processing information from %s discovered devices", - len(discovered_devices), - ) - - for device in discovered_devices: - device["hostname"] = None - device["date_time"] = {} - device["services"] = [] - - try: - # connect to device as PRE_AUTH (no auth at all) - client = ONVIFClient(host=device["host"], port=device["port"]) - device_service = client.devicemgmt() # should not fail ! - except ONVIFOperationException as e: - logger.warning( - "Failed to process discovered device %s:%s: %s", - device["host"], - device["port"], - e, - ) - continue - - try: - device_hostname = safe_call(device_service.GetHostname) - if device_hostname: - device["hostname"] = device_hostname.Name - except (KeyError, ONVIFOperationException): - pass - - try: - device_date_time = safe_call(device_service.GetSystemDateAndTime) - - if device_date_time: - utc = device_date_time.UTCDateTime - local = device_date_time.LocalDateTime - - device["date_time"]["utc"] = ( - ( - f"{utc.Date.Year:04d}-{utc.Date.Month:02d}-{utc.Date.Day:02d}" - f"T{utc.Time.Hour:02d}:{utc.Time.Minute:02d}:{utc.Time.Second:02d}" - ) - if utc - else None - ) - - device["date_time"]["local"] = ( - ( - f"{local.Date.Year:04d}-{local.Date.Month:02d}-{local.Date.Day:02d}" - f"T{local.Time.Hour:02d}:{local.Time.Minute:02d}:{local.Time.Second:02d}" - ) - if local - else None - ) - except (KeyError, ONVIFOperationException): - pass - - try: - if client.services: - for service in client.services: - namespace = getattr(service, "Namespace", "") - service_mappings: tuple[tuple[str, str], ...] = ( - ONVIF_NAMESPACE_MAP.get(namespace, ()) - ) - - if not service_mappings: - # Unknown namespace - device["services"].append(f"unknown({namespace})") - else: - # Add the main service entry (first service in mappings) - device["services"].append(service_mappings[0][0]) - except (KeyError, ONVIFOperationException): - pass - - return discovered_devices - - def _parse_responses( - self, responses: list[dict[str, str]], prefer_https: bool = False - ) -> list[dict[str, Any]]: - """Parse WS-Discovery responses into device information. - - Args: - responses (list[dict[str, str]]): List of raw XML responses - prefer_https (bool): If True, prioritize HTTPS XAddrs - - Returns: - List of parsed device information - """ - logger.debug("Parsing %s WS-Discovery responses", len(responses)) - devices = [] - - for resp in responses: - try: - device_info = self._parse_single_response(resp["xml"], prefer_https) - if device_info and device_info.get("host"): - devices.append(device_info) - logger.debug( - "Parsed device: %s:%s", device_info["host"], device_info["port"] - ) - except (KeyError, TypeError, ValueError) as e: - # Skip malformed responses - logger.debug("Failed to parse response: %s", e) - continue - - logger.debug("Successfully parsed %s valid devices", len(devices)) - return devices - def _filter_devices( self, devices: list[dict[str, Any]], search_term: str ) -> list[dict[str, Any]]: @@ -377,7 +252,8 @@ def _filter_devices( Args: devices (list[dict[str, Any]]): List of discovered devices - search_term (str): Search string to match against types/scopes (case-insensitive) + search_term (str): Search string to match against types/scopes + (case-insensitive) Returns: Filtered list of devices matching the search term @@ -405,6 +281,126 @@ def _filter_devices( return filtered + def _process_single_device(self, device: dict[str, Any]) -> dict[str, Any]: + """Enrich a single discovered device with unauthenticated information. + + Connects to the discovered device without authentication and attempts to + retrieve information that is available without credentials, including the + device hostname, system date and time, and supported ONVIF services. + + Args: + device: Device dictionary containing at least the host and port required + to establish an ONVIF connection. + + Returns: + The discovered device enriched with hostname, date/time, and service + information where available. + """ + device["hostname"] = None + device["date_time"] = {} + device["services"] = [] + + try: + # connect to device as PRE_AUTH (no auth at all) + client = ONVIFClient(host=device["host"], port=device["port"]) + device_service = client.devicemgmt() # should not fail ! + except ONVIFOperationException as e: + logger.warning( + "Failed to process discovered device %s:%s: %s", + device["host"], + device["port"], + e, + ) + return device + + try: + device_hostname = safe_call(device_service.GetHostname) + if device_hostname: + device["hostname"] = device_hostname.Name + except (KeyError, ONVIFOperationException): + pass + + try: + device_date_time = safe_call(device_service.GetSystemDateAndTime) + + if device_date_time: + utc = device_date_time.UTCDateTime + local = device_date_time.LocalDateTime + + device["date_time"]["utc"] = ( + ( + f"{utc.Date.Year:04d}-{utc.Date.Month:02d}-{utc.Date.Day:02d}" + f"T{utc.Time.Hour:02d}:{utc.Time.Minute:02d}:{utc.Time.Second:02d}" + ) + if utc + else None + ) + + device["date_time"]["local"] = ( + ( + f"{local.Date.Year:04d}-{local.Date.Month:02d}-{local.Date.Day:02d}" + f"T{local.Time.Hour:02d}:{local.Time.Minute:02d}:{local.Time.Second:02d}" + ) + if local + else None + ) + except (KeyError, ONVIFOperationException): + pass + + try: + if client.services: + for service in client.services: + namespace = getattr(service, "Namespace", "") + service_mappings: tuple[tuple[str, str], ...] = ( + ONVIF_NAMESPACE_MAP.get(namespace, ()) + ) + + if not service_mappings: + # Unknown namespace + device["services"].append(f"unknown({namespace})") + else: + # Add the main service entry (first service in mappings) + device["services"].append(service_mappings[0][0]) + except (KeyError, ONVIFOperationException): + pass + + return device + + def _process_device( + self, discovered_devices: list[dict[str, Any]] + ) -> list[dict[str, Any]]: + """Enrich discovered devices with unauthenticated device information. + + Connects to each discovered device without authentication and processes + devices concurrently using a thread pool. Information that is available + without credentials includes the device hostname, system date and time, + and supported ONVIF services. + + Devices for which an ONVIF operation fails are skipped and do not prevent + the remaining discovered devices from being processed. + + Args: + discovered_devices: List of device dictionaries returned by the + discovery process. Each device must contain at least the host and + port required to establish an ONVIF connection. + + Returns: + The list of discovered devices enriched with hostname, date/time, and + service information where available. + """ + logger.debug( + "Processing information from %s discovered devices", + len(discovered_devices), + ) + + if not discovered_devices: + return discovered_devices + + max_workers = min(len(discovered_devices), DEFAULT_MAX_WORKERS) + + with ThreadPoolExecutor(max_workers=max_workers) as executor: + return list(executor.map(self._process_single_device, discovered_devices)) + def _parse_single_response( self, xml_data: str, prefer_https: bool = False ) -> dict[str, Any] | None: @@ -476,12 +472,44 @@ def _parse_single_response( return device_info - except etree.XMLSyntaxError: + except etree.XMLSyntaxError as e1: + logger.warning("Error occurred while parsing device info: %s", e1) return None - except Exception as e: # pylint: disable=broad-except - logger.warning("Error occurred while parsing device info: %s", e) + except (TypeError, ValueError, AttributeError) as e2: + logger.warning("Error occurred while parsing device info: %s", e2) return None + def _parse_responses( + self, responses: list[dict[str, str]], prefer_https: bool = False + ) -> list[dict[str, Any]]: + """Parse WS-Discovery responses into device information. + + Args: + responses (list[dict[str, str]]): List of raw XML responses + prefer_https (bool): If True, prioritize HTTPS XAddrs + + Returns: + List of parsed device information + """ + logger.debug("Parsing %s WS-Discovery responses", len(responses)) + devices = [] + + for resp in responses: + try: + device_info = self._parse_single_response(resp["xml"], prefer_https) + if device_info and device_info.get("host"): + devices.append(device_info) + logger.debug( + "Parsed device: %s:%s", device_info["host"], device_info["port"] + ) + except (KeyError, TypeError, ValueError) as e: + # Skip malformed responses + logger.debug("Failed to parse response: %s", e) + continue + + logger.debug("Successfully parsed %s valid devices", len(devices)) + return devices + def _parse_xaddr( self, device_info: dict[str, Any], prefer_https: bool = False ) -> None: diff --git a/tests/utilities/test_discovery.py b/tests/utilities/test_discovery.py index a1e94ff7..5b28abc6 100644 --- a/tests/utilities/test_discovery.py +++ b/tests/utilities/test_discovery.py @@ -1141,7 +1141,6 @@ def test_probe_message_contains_required_ws_discovery_fields(self): assert "http://schemas.xmlsoap.org/ws/2005/04/discovery/Probe" in probe assert "urn:uuid:{uuid}" in probe assert "urn:schemas-xmlsoap-org:ws:2005:04:discovery" in probe - assert "tds:Device" in probe # Socket modules From bf0a574d4ddf10b1f75b70f8966d81fa20ac9a8f Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Wed, 7 Oct 2026 22:33:03 +0700 Subject: [PATCH 08/37] feat(docs): Improve GitHub releases metadata display (#162) --- docs/javascripts/github-releases.js | 112 ++++++++++++++++++++++------ docs/stylesheets/extra.css | 23 +++--- 2 files changed, 104 insertions(+), 31 deletions(-) diff --git a/docs/javascripts/github-releases.js b/docs/javascripts/github-releases.js index 49306f35..b1acc630 100644 --- a/docs/javascripts/github-releases.js +++ b/docs/javascripts/github-releases.js @@ -1,7 +1,8 @@ /* global DOMPurify, marked, document$ */ -const GITHUB_API = - "https://api.github.com/repos/nirsimetri/onvif-python/releases?per_page=100"; +const GITHUB_REPOSITORY = "nirsimetri/onvif-python"; +const [, GITHUB_REPOSITORY_NAME] = GITHUB_REPOSITORY.split("/"); +const GITHUB_API = `https://api.github.com/repos/${GITHUB_REPOSITORY}/releases?per_page=100`; const RELEASES_NAV_STATE_KEY = "github-releases-nav-open"; @@ -116,7 +117,7 @@ function createReleaseNav(releases) { const link = document.createElement("a"); link.className = "md-nav__link"; - link.href = `/onvif-python/releases/#${encodeURIComponent( + link.href = `/${GITHUB_REPOSITORY_NAME}/releases/#${encodeURIComponent( release.tag_name )}`; @@ -143,8 +144,7 @@ function createReleaseNav(releases) { const allReleasesLink = document.createElement("a"); allReleasesLink.className = "md-nav__link"; - allReleasesLink.href = - "https://github.com/nirsimetri/onvif-python/releases"; + allReleasesLink.href = `https://github.com/${GITHUB_REPOSITORY}/releases`; allReleasesLink.target = "_blank"; allReleasesLink.rel = "noopener noreferrer"; @@ -203,11 +203,55 @@ function renderRelease(releases, tag = null) { const heading = document.createElement("h2"); heading.textContent = release.name || release.tag_name; - const dateElement = document.createElement("p"); - dateElement.className = "github-release__date"; + const metadataElement = document.createElement("p"); + metadataElement.className = "github-release__metadata"; - const date = new Date(release.published_at); - dateElement.textContent = date.toLocaleDateString(); + if (release.immutable || release.tag_name || release.published_at) { + if(release.published_at){ + const dateElement = document.createElement("span"); + dateElement.className = "github-release__date"; + + const date = new Date(release.published_at); + const year = date.getFullYear(); + const month = date.toLocaleString("en-US", { month: "long" }); + const day = String(date.getDate()).padStart(2, "0"); + + dateElement.textContent = `🗓️ ${year}-${month}-${day}`; + metadataElement.appendChild(dateElement); + } + + if (release.immutable) { + const immutableElement = document.createElement("span"); + immutableElement.className = "github-release__immutable"; + + const lockIcon = document.createElement("span"); + lockIcon.textContent = "🔒"; + lockIcon.setAttribute("aria-hidden", "true"); + + const immutableText = document.createElement("span"); + immutableText.textContent = "Immutable"; + + immutableElement.appendChild(lockIcon); + immutableElement.appendChild(immutableText); + metadataElement.appendChild(immutableElement); + } + + if (release.tag_name) { + const tagElement = document.createElement("span"); + tagElement.className = "github-release__tag"; + + const tagIcon = document.createElement("span"); + tagIcon.textContent = "🏷️"; + tagIcon.setAttribute("aria-hidden", "true"); + + const tagText = document.createElement("span"); + tagText.textContent = release.tag_name; + + tagElement.appendChild(tagIcon); + tagElement.appendChild(tagText); + metadataElement.appendChild(tagElement); + } + } const body = document.createElement("div"); body.className = "github-release__body"; @@ -223,7 +267,7 @@ function renderRelease(releases, tag = null) { body.appendChild(safeFragment); article.appendChild(heading); - article.appendChild(dateElement); + article.appendChild(metadataElement); article.appendChild(body); container.replaceChildren(article); @@ -396,23 +440,49 @@ function processGitHubReferences(markdown) { // Convert GitHub issue/PR URLs to # references. text = text.replace( - /https:\/\/github\.com\/nirsimetri\/onvif-python\/(issues|pull)\/(\d+)/g, - (_, type, number) => - `[#${number}](https://github.com/nirsimetri/onvif-python/${type}/${number})` + /https:\/\/github\.com\/([^/\s]+)\/([^/\s]+)\/(issues|pull)\/(\d+)/g, + (_, owner, repo, type, number) => { + const repository = `${owner}/${repo}`; + const url = `https://github.com/${repository}/${type}/${number}`; + + if (repository === GITHUB_REPOSITORY) { + return `[#${number}](${url})`; + } + + return `[${repository}#${number}](${url})`; + }, ); // Convert GitHub commit URLs to short commit hashes. text = text.replace( - /https:\/\/github\.com\/nirsimetri\/onvif-python\/commit\/([a-f0-9]{7,40})/gi, - (_, hash) => - `[${hash.substring(0, 7)}](https://github.com/nirsimetri/onvif-python/commit/${hash})` - ); + /https:\/\/github\.com\/([^/\s]+)\/([^/\s]+)\/commit\/([a-f0-9]{7,40})/gi, + (_, owner, repo, hash) => { + const repository = `${owner}/${repo}`; + const url = `https://github.com/${repository}/commit/${hash}`; - // Convert @username to GitHub profile links. - text = text.replace( - /(^|[^\w])@([a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?)/g, - "$1[@$2](https://github.com/$2)" + if (repository === GITHUB_REPOSITORY) { + return `[\`${hash.substring(0, 7)}\`](${url})`; + } + + return `[${repository}@\`${hash.substring(0, 7)}\`](${url})`; + }, ); + // Convert @username to GitHub profile links, except inside inline code. + text = text + .split(/(`[^`]*`)/g) + .map((part, index) => { + // Odd parts are inline code blocks. + if (index % 2 === 1) { + return part; + } + + return part.replace( + /(^|[^\w])@([a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?)/g, + "$1[@$2](https://github.com/$2)", + ); + }) + .join(""); + return text; } \ No newline at end of file diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 89d2efc6..65a5b465 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -56,21 +56,24 @@ margin-bottom: 3rem; } -.github-release__date { - color: var(--md-default-fg-color--light); +.github-release__metadata { + display: inline-flex; + align-items: center; + gap: 1rem; font-size: 0.8rem; + margin-bottom: 0rem; } -.github-release__body { - margin-top: 2rem; -} - -.github-release__body h2 { - margin-top: 2rem; +.github-release__date, +.github-release__immutable, +.github-release__tag { + display: inline-flex; + align-items: center; + gap: 0.25rem; } -.github-release__body h3 { - margin-top: 1.5rem; +.github-release__body { + margin-top: 0rem; } .highlight .go::before { From aec484d2ffe8e9963270038137277c869fa40ea2 Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Thu, 8 Oct 2026 05:29:11 +0700 Subject: [PATCH 09/37] chore(pylint): Update pylint config and adjust formatting settings (#163) --- pyproject.toml | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index e57409af..82fe2baf 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,3 +1,10 @@ +[build-system] +requires = [ + "setuptools>=77.0.3", + "wheel>=0.48.0,<1.0.0", +] +build-backend = "setuptools.build_meta" + [project] name = "onvif-python" version = "0.4.4" @@ -76,13 +83,6 @@ docs = [ [project.scripts] onvif = "onvif.cli.main:main" -[build-system] -requires = [ - "setuptools>=77.0.3", - "wheel>=0.48.0,<1.0.0", -] -build-backend = "setuptools.build_meta" - [tool.setuptools] license-files = ["LICENSE", "NOTICE"] @@ -123,8 +123,8 @@ skip = [ ] [tool.docformatter] -wrap-summaries = 150 -wrap-descriptions = 150 +wrap-summaries = 88 # --black +wrap-descriptions = 88 # --black pre-summary-newline = true close-quotes-on-newline = true @@ -142,13 +142,19 @@ ignore-paths = [ load-plugins = ["pylint_pytest"] [tool.pylint.format] -max-line-length = 150 +max-line-length = 130 [tool.pylint."messages control"] disable = [ - "duplicate-code", - "R0917", # too-many-positional-arguments + "C0103", # invalid-name + "R0801", # duplicate-code + "R0902", # too-many-instance-attributes + "R0903", # too-few-public-methods + "R0904", # too-many-public-methods "R0913", # too-many-arguments + "R0914", # too-many-locals + "R0915", # too-many-statements + "R0917", # too-many-positional-arguments ] [tool.mypy] From 320c52aed95db542079c9901025e625a26886eac Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Thu, 8 Oct 2026 05:43:42 +0700 Subject: [PATCH 10/37] style: Enforce `pylint` standard and miscellaneous style (#164) --- onvif/cli/helpers/wsdl_parser.py | 8 ++--- onvif/cli/interactive/context.py | 4 +-- onvif/cli/interactive/navigation.py | 2 +- onvif/cli/interactive/reference.py | 2 +- onvif/cli/interactive/service.py | 4 +-- onvif/cli/interactive/utils.py | 1 - onvif/cli/utils.py | 4 +-- onvif/client.py | 15 ++++------ onvif/operator.py | 1 - onvif/services/accesscontrol.py | 7 ++--- onvif/services/accessrules.py | 7 ++--- onvif/services/actionengine.py | 7 ++--- onvif/services/analytics/analytics.py | 7 ++--- onvif/services/analytics/ruleengine.py | 7 ++--- onvif/services/analyticsdevice.py | 9 +++--- onvif/services/appmgmt.py | 7 ++--- onvif/services/authenticationbehavior.py | 9 +++--- onvif/services/credential.py | 7 ++--- onvif/services/deviceio.py | 9 +++--- onvif/services/devicemgmt.py | 10 +++---- onvif/services/display.py | 9 +++--- onvif/services/doorcontrol.py | 7 ++--- onvif/services/events/events.py | 7 ++--- onvif/services/events/notification.py | 6 ++-- .../services/events/pausable_subscription.py | 6 ++-- onvif/services/events/pullpoint.py | 7 ++--- onvif/services/events/subscription.py | 6 ++-- onvif/services/imaging.py | 9 +++--- onvif/services/media.py | 10 +++---- onvif/services/media2.py | 8 ++--- onvif/services/provisioning.py | 7 ++--- onvif/services/ptz.py | 9 +++--- onvif/services/receiver.py | 10 +++---- onvif/services/recording.py | 9 +++--- onvif/services/replay.py | 10 +++---- onvif/services/schedule.py | 8 ++--- onvif/services/search.py | 9 +++--- onvif/services/security/advancedsecurity.py | 7 ++--- .../services/security/authorizationserver.py | 7 ++--- onvif/services/security/dot1x.py | 7 ++--- onvif/services/security/jwt.py | 7 ++--- onvif/services/security/keystore.py | 7 ++--- onvif/services/security/mediasigning.py | 11 +++---- onvif/services/security/tlsserver.py | 7 ++--- onvif/services/thermal.py | 7 ++--- onvif/services/uplink.py | 7 ++--- onvif/utils/discovery.py | 3 +- onvif/utils/exceptions.py | 4 ++- onvif/utils/service.py | 3 +- onvif/utils/zeep.py | 2 +- tests/cli/test_cli_helper_execution.py | 10 +++---- tests/cli/test_cli_helper_files.py | 29 +++++++++---------- tests/cli/test_cli_helper_products.py | 2 -- tests/cli/test_cli_helper_wsdl_parser.py | 1 - tests/cli/test_cli_interactive_navigation.py | 2 +- tests/cli/test_cli_interactive_shell.py | 2 +- tests/cli/test_cli_interactive_utils.py | 2 +- tests/cli/test_cli_utils.py | 3 +- tests/services/base_service_test.py | 14 +++++---- tests/services/test_jwt.py | 6 +++- tests/test_client.py | 2 +- tests/test_core.py | 1 - tests/test_operator.py | 2 +- tests/utilities/test_exceptions.py | 6 ++-- tests/utilities/test_plugins.py | 1 - tests/utilities/test_service.py | 5 ++-- tests/utilities/test_wsdl.py | 2 +- tests/utilities/test_zeep.py | 11 ++++--- 68 files changed, 207 insertions(+), 237 deletions(-) diff --git a/onvif/cli/helpers/wsdl_parser.py b/onvif/cli/helpers/wsdl_parser.py index f734b65b..48591c41 100644 --- a/onvif/cli/helpers/wsdl_parser.py +++ b/onvif/cli/helpers/wsdl_parser.py @@ -38,7 +38,7 @@ class OperationTypeInfo(TypedDict): output: MessageInfo | None -# pylint: disable=too-many-locals,too-many-statements,too-many-branches +# pylint: disable=too-many-branches def get_method_documentation( service_obj: Any, method_name: str ) -> dict[str, Any] | None: @@ -449,7 +449,7 @@ def _load_imported_schemas(root, schema_context: dict, namespaces: dict): continue -# pylint: disable=too-many-locals,too-many-statements,too-many-branches +# pylint: disable=too-many-branches def resolve_element_type( element_name: str, namespaces: dict, @@ -612,7 +612,7 @@ def resolve_element_type( return parameters -# pylint: disable=too-many-locals,too-many-statements,too-many-branches +# pylint: disable=too-many-branches def resolve_complex_type( type_name: str, namespaces: dict, @@ -802,7 +802,7 @@ def resolve_complex_type( return children -# pylint: disable=too-many-locals,too-many-statements,too-many-branches +# pylint: disable=too-many-branches def parse_inline_complex_type( complex_type, namespaces: dict, diff --git a/onvif/cli/interactive/context.py b/onvif/cli/interactive/context.py index e96a13db..c3a8c602 100644 --- a/onvif/cli/interactive/context.py +++ b/onvif/cli/interactive/context.py @@ -11,7 +11,7 @@ @dataclass -class ShellContext: # pylint: disable=too-many-instance-attributes +class ShellContext: """Store shared state for the interactive shell.""" UNSET = object() @@ -26,7 +26,7 @@ class ShellContext: # pylint: disable=too-many-instance-attributes ) # For storing command results stored_metadata: dict[str, dict[str, Any]] = field( default_factory=dict - ) # For storing metadata about stored data (service, method + ) # For storing metadata about stored data (service, method) last_result: Any = field(default=UNSET, repr=False) last_method: str | None = None diff --git a/onvif/cli/interactive/navigation.py b/onvif/cli/interactive/navigation.py index b352a346..c5381765 100644 --- a/onvif/cli/interactive/navigation.py +++ b/onvif/cli/interactive/navigation.py @@ -76,7 +76,7 @@ def do_up(self, _line) -> None: else: print("Not in service mode") - # pylint: disable=too-many-locals,too-many-branches,too-many-statements + # pylint: disable=too-many-branches def do_enter_service(self, line) -> None: """Enter service mode with optional arguments for services that require them.""" # Parse service name and arguments diff --git a/onvif/cli/interactive/reference.py b/onvif/cli/interactive/reference.py index d9c42a0f..08284374 100644 --- a/onvif/cli/interactive/reference.py +++ b/onvif/cli/interactive/reference.py @@ -37,7 +37,7 @@ def do_store(self, line) -> None: ) return - UNSET = object() # pylint: disable=invalid-name + UNSET = object() if self.context.last_result is UNSET: print(f"{colorize('Error:', 'red')} No result to store") diff --git a/onvif/cli/interactive/service.py b/onvif/cli/interactive/service.py index 99669463..1fc425c8 100644 --- a/onvif/cli/interactive/service.py +++ b/onvif/cli/interactive/service.py @@ -147,7 +147,7 @@ def do_desc(self, line) -> None: f"No documentation or parameter info found for method '{method_name}'." ) - # pylint: disable=too-many-branches,too-many-statements + # pylint: disable=too-many-branches def do_type(self, line) -> None: """Show input and output types for a method. @@ -178,7 +178,7 @@ def do_type(self, line) -> None: if type_info: # Helper function to display parameters recursively with tree-style indentation - # pylint: disable=too-many-locals,too-many-branches + # pylint: disable=too-many-branches def display_params(params, prefix_lines=None, is_root_level=False): """Display parameters with tree-style formatting. diff --git a/onvif/cli/interactive/utils.py b/onvif/cli/interactive/utils.py index 89cb4193..bbf2dc13 100644 --- a/onvif/cli/interactive/utils.py +++ b/onvif/cli/interactive/utils.py @@ -48,7 +48,6 @@ def update_prompt(self) -> None: f":{self.context.args.port} > " ) - # pylint: disable=too-many-locals def _display_grid(self, items: list): """Display items in grid format matching TAB completion (vertical layout)""" if not items: diff --git a/onvif/cli/utils.py b/onvif/cli/utils.py index 4f9f0dcb..7dcecca7 100644 --- a/onvif/cli/utils.py +++ b/onvif/cli/utils.py @@ -22,7 +22,7 @@ def _is_valid_json(s: str) -> bool: return True -# pylint: disable=too-many-statements,too-many-branches +# pylint: disable=too-many-branches def parse_json_params(params_str: str) -> dict[str, Any]: """Parse parameters from a JSON string or key=value pairs into a dict. @@ -352,7 +352,7 @@ def format_services_list(services_list: list) -> str: return result -# pylint: disable=too-many-statements,too-many-branches +# pylint: disable=too-many-branches def get_device_available_services(client) -> list: """Get list of services actually available on the connected device. diff --git a/onvif/client.py b/onvif/client.py index 75e9af5f..0a43fddb 100644 --- a/onvif/client.py +++ b/onvif/client.py @@ -103,8 +103,6 @@ def wrapper(*args: P.args, **kwargs: P.kwargs) -> R: return wrapper -# pylint: disable=too-many-instance-attributes,too-many-locals -# pylint: disable=too-many-public-methods,too-many-statements class ONVIFClient: """High-level ONVIF client for interacting with ONVIF-compliant devices. @@ -164,7 +162,8 @@ def __init__( - Added in [`>=v0.1.0`](/onvif-python/releases/#v0.1.0): `wsdl_dir` - Added in [`>=v0.2.2`](/onvif-python/releases/#v0.2.2): `plugins` - Added in [`>=v0.3.0`](/onvif-python/releases/#v0.3.0): `http_digest` - - Changed in [`>=v0.3.0`](/onvif-python/releases/#v0.3.0): `username` → `str | None`, `password` → `str | None` + - Changed in [`>=v0.3.0`](/onvif-python/releases/#v0.3.0): `username` → `str | None`, + `password` → `str | None` """ logger.info("Initializing ONVIF client for %s:%d", host, port) logger.debug( @@ -559,7 +558,7 @@ def events(self) -> Events: return self._events @service - def pullpoint(self, SubscriptionRef) -> PullPoint: # pylint: disable=invalid-name + def pullpoint(self, SubscriptionRef) -> PullPoint: """Access the PullPoint service.""" logger.debug("Initializing PullPoint service") return self._get_subscription_service( @@ -579,9 +578,7 @@ def notification(self) -> Notification: return self._notification @service - def subscription( - self, SubscriptionRef # pylint: disable=invalid-name - ) -> Subscription: + def subscription(self, SubscriptionRef) -> Subscription: """Access the Subscription service.""" logger.debug("Initializing Subscription service") return self._get_subscription_service( @@ -591,9 +588,7 @@ def subscription( ) @service - def pausable_subscription( - self, SubscriptionRef # pylint: disable=invalid-name - ) -> PausableSubscription: + def pausable_subscription(self, SubscriptionRef) -> PausableSubscription: """Access the PausableSubscription service.""" logger.debug("Initializing PausableSubscription service") return self._get_subscription_service( diff --git a/onvif/operator.py b/onvif/operator.py index 1443c7fc..ed139584 100644 --- a/onvif/operator.py +++ b/onvif/operator.py @@ -92,7 +92,6 @@ class CacheMode(Enum): """ -# pylint: disable=too-many-instance-attributes,too-many-locals class ONVIFOperator: """Low-level ONVIF service operator using Zeep SOAP client. diff --git a/onvif/services/accesscontrol.py b/onvif/services/accesscontrol.py index 6204481f..4ff5cd72 100644 --- a/onvif/services/accesscontrol.py +++ b/onvif/services/accesscontrol.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,too-many-public-methods class AccessControl(ONVIFService): """AccessControl service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 2.3 (May 2013) | | **Binding name** | `PACSBinding` (`ver10/pacs/accesscontrol.wsdl`) | - | **Operations** | [accesscontrol.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/pacs/accesscontrol.wsdl) | - | **Specification** | [AccessControl.xml](https://developer.onvif.org/pub/specs/branches/development/doc/AccessControl.xml) | + | **Operations** | [accesscontrol.wsdl](https://www.onvif.org/ver10/pacs/accesscontrol.wsdl) | + | **Spec** | [AccessControl](https://www.onvif.org/specs/srv/access/ONVIF-AccessControl-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/accessrules.py b/onvif/services/accessrules.py index c8b0e5b2..00f2a6c9 100644 --- a/onvif/services/accessrules.py +++ b/onvif/services/accessrules.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class AccessRules(ONVIFService): """AccessRules service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 2.6 (June 2015) | | **Binding name** | `AccessRulesBinding` (`ver10/accessrules/wsdl/accessrules.wsdl`) | - | **Operations** | [accessrules.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/accessrules/wsdl/accessrules.wsdl) | - | **Specification** | [AccessRules.xml](https://developer.onvif.org/pub/specs/branches/development/doc/AccessRules.xml) | + | **Operations** | [accessrules.wsdl](https://www.onvif.org/ver10/accessrules/wsdl/accessrules.wsdl) | + | **Spec** | [AccessRules](https://www.onvif.org/specs/srv/access/ONVIF-AccessRules-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/actionengine.py b/onvif/services/actionengine.py index f9c91aad..e5d9da3f 100644 --- a/onvif/services/actionengine.py +++ b/onvif/services/actionengine.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class ActionEngine(ONVIFService): """ActionEngine service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 2.2 (September 2012) | | **Binding name** | `ActionEngineBinding` (`ver10/actionengine.wsdl`) | - | **Operations** | [actionengine.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/actionengine.wsdl) | - | **Specification** | [ActionEngine.xml](https://developer.onvif.org/pub/specs/branches/development/doc/ActionEngine.xml) | + | **Operations** | [actionengine.wsdl](https://www.onvif.org/ver10/actionengine.wsdl) | + | **Spec** | [ActionEngine](https://www.onvif.org/specs/srv/act/ONVIF-ActionEngine-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/analytics/analytics.py b/onvif/services/analytics/analytics.py index 52a97ea1..6253bbec 100644 --- a/onvif/services/analytics/analytics.py +++ b/onvif/services/analytics/analytics.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class Analytics(ONVIFService): """Analytics service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 2.41 (December 2013) | | **Binding name** | `AnalyticsEngineBinding` (`ver20/analytics/wsdl/analytics.wsdl`) | - | **Operations** | [analytics.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/wsdl/analytics.wsdl) | - | **Specification** | [Analytics.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Analytics.xml) | + | **Operations** | [analytics.wsdl](https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl) | + | **Spec** | [Analytics](https://www.onvif.org/specs/srv/analytics/ONVIF-Analytics-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/analytics/ruleengine.py b/onvif/services/analytics/ruleengine.py index 252ab0d2..3e44223a 100644 --- a/onvif/services/analytics/ruleengine.py +++ b/onvif/services/analytics/ruleengine.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class RuleEngine(ONVIFService): """Analytics (RuleEngine) service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 2.41 (December 2013) | | **Binding name** | `RuleEngineBinding` (`ver20/analytics/wsdl/analytics.wsdl`) | - | **Operations** | [analytics.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/wsdl/analytics.wsdl) | - | **Specification** | [Analytics.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Analytics.xml) | + | **Operations** | [analytics.wsdl](https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl) | + | **Spec** | [Analytics](https://www.onvif.org/specs/srv/analytics/ONVIF-Analytics-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/analyticsdevice.py b/onvif/services/analyticsdevice.py index fa4a1148..afb7db03 100644 --- a/onvif/services/analyticsdevice.py +++ b/onvif/services/analyticsdevice.py @@ -5,8 +5,8 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class AnalyticsDevice(ONVIFService): + # pylint: disable=line-too-long """The AnalyticsDevice service (AnalyticsDeviceBinding) aka 'Video Analytics Device' has been marked as obsolete since ONVIF Release 18.12. @@ -21,14 +21,15 @@ class AnalyticsDevice(ONVIFService): available on the device and calling this class will result in SOAP faults. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 2.1 (June 2011), split from Core 2.0 | | **Deprecated** | ONVIF Release 18.12 (December 2018) | | **Binding name** | `AnalyticsDeviceBinding` (`ver10/analyticsdevice.wsdl`) | | **Successor** | `Analytics` Service (`ver20/analytics/wsdl/analytics.wsdl`) | - | **Operations** | [analyticsdevice.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/analyticsdevice.wsdl) | - | **Specification** | [Video Analytics Device Spec](https://www.onvif.org/specs/srv/analytics/ONVIF-VideoAnalyticsDevice-Service-Spec-v211.pdf) | + | **Operations** | [analyticsdevice.wsdl](https://www.onvif.org/ver10/analyticsdevice.wsdl) | + | **Spec** | [Video Analytics Device](https://www.onvif.org/specs/srv/analytics/ONVIF-VideoAnalyticsDevice-Service-Spec-v211.pdf) | """ + # pylint: enable=line-too-long def __init__(self, xaddr=None, **kwargs): definition = ONVIFWSDL.get_definition("analyticsdevice") diff --git a/onvif/services/appmgmt.py b/onvif/services/appmgmt.py index bb3bcaf9..b922baf2 100644 --- a/onvif/services/appmgmt.py +++ b/onvif/services/appmgmt.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class AppManagement(ONVIFService): """AppManagement service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 19.12 (December 2019) | | **Binding name** | `AppManagementBinding` (`ver10/appmgmt/wsdl/appmgmt.wsdl`) | - | **Operations** | [appmgmt.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/appmgmt/wsdl/appmgmt.wsdl) | - | **Specification** | [AppMgmt.xml](https://developer.onvif.org/pub/specs/branches/development/doc/AppMgmt.xml) | + | **Operations** | [appmgmt.wsdl](https://www.onvif.org/ver10/appmgmt/wsdl/appmgmt.wsdl) | + | **Spec** | [AppMgmt](https://www.onvif.org/specs/srv/appmgmt/ONVIF-ApplicationManagement-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/authenticationbehavior.py b/onvif/services/authenticationbehavior.py index 9868d263..4bcef227 100644 --- a/onvif/services/authenticationbehavior.py +++ b/onvif/services/authenticationbehavior.py @@ -5,17 +5,18 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,line-too-long class AuthenticationBehavior(ONVIFService): + # pylint: disable=line-too-long """AuthenticationBehavior service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 18.06 (June 2018) | | **Binding name** | `AuthenticationBehaviorBinding` (`ver10/authenticationbehavior/wsdl/authenticationbehavior.wsdl`) | - | **Operations** | [authenticationbehavior.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/authenticationbehavior/wsdl/authenticationbehavior.wsdl) | - | **Specification** | [AuthenticationBehavior.xml](https://developer.onvif.org/pub/specs/branches/development/doc/AuthenticationBehavior.xml) | + | **Operations** | [authenticationbehavior.wsdl](https://www.onvif.org/ver10/authenticationbehavior/wsdl/authenticationbehavior.wsdl) | + | **Spec** | [AuthenticationBehavior](https://www.onvif.org/specs/srv/access/ONVIF-AuthenticationBehavior-Service-Spec.pdf) | """ + # pylint: enable=line-too-long def __init__(self, xaddr=None, **kwargs): definition = ONVIFWSDL.get_definition("authenticationbehavior") diff --git a/onvif/services/credential.py b/onvif/services/credential.py index 0084973d..051adbe8 100644 --- a/onvif/services/credential.py +++ b/onvif/services/credential.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,too-many-public-methods class Credential(ONVIFService): """Credential service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 2.6 (June 2015) | | **Binding name** | `CredentialBinding` (`ver10/credential/wsdl/credential.wsdl`) | - | **Operations** | [credential.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/credential/wsdl/credential.wsdl) | - | **Specification** | [Credential.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Credential.xml) | + | **Operations** | [credential.wsdl](https://www.onvif.org/ver10/credential/wsdl/credential.wsdl) | + | **Spec** | [Credential](https://www.onvif.org/specs/srv/access/ONVIF-Credential-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/deviceio.py b/onvif/services/deviceio.py index 736db436..ef8572f6 100644 --- a/onvif/services/deviceio.py +++ b/onvif/services/deviceio.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,too-many-public-methods class DeviceIO(ONVIFService): """DeviceIO service client. | Property | Details | - | --- | --- | - | **First introduced** | ONVIF Release 2.1 (June 2011) Split from Core 2.0 | + | -------- | ------- | + | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | | **Binding name** | `DeviceIOBinding` (`ver10/deviceio.wsdl`) | - | **Operations** | [deviceio.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/deviceio.wsdl) | - | **Specification** | [DeviceIo.xml](https://developer.onvif.org/pub/specs/branches/development/doc/DeviceIo.xml) | + | **Operations** | [deviceio.wsdl](https://www.onvif.org/ver10/deviceio.wsdl) | + | **Spec** | [DeviceIO](https://www.onvif.org/specs/srv/io/ONVIF-DeviceIo-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/devicemgmt.py b/onvif/services/devicemgmt.py index 6dfcc2bd..7022355c 100644 --- a/onvif/services/devicemgmt.py +++ b/onvif/services/devicemgmt.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,too-many-public-methods class Device(ONVIFService): """Device service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Core | | **Binding name** | `DeviceBinding` (`ver10/device/wsdl/devicemgmt.wsdl`) | - | **Operations** | [devicemgmt.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/device/wsdl/devicemgmt.wsdl) | - | **Specification** | [Core.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Core.xml) | + | **Operations** | [devicemgmt.wsdl](https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl) | + | **Spec** | [Core](https://www.onvif.org/specs/core/ONVIF-Core-Specification.pdf) | """ def __init__(self, xaddr=None, **kwargs): @@ -69,7 +68,8 @@ def SendAuxiliaryCommand(self, AuxiliaryCommand): - tt: WashingProcedure |Off - Request to stop the washing procedure. - tt:IRLamp|On - Request to turn ON an IR illuminator attached to the unit. - tt:IRLamp|Off - Request to turn OFF an IR illuminator attached to the unit. - - tt:IRLamp|Auto - Request to configure an IR illuminator attached to the unit so that it automatically turns ON and OFF. + - tt:IRLamp|Auto - Request to configure an IR illuminator attached to the unit + so that it automatically turns ON and OFF. A device that indicates auxiliary service capability shall support this command. """ diff --git a/onvif/services/display.py b/onvif/services/display.py index b53c0504..22d644cd 100644 --- a/onvif/services/display.py +++ b/onvif/services/display.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class Display(ONVIFService): """Display service client. | Property | Details | - | --- | --- | - | **First introduced** | ONVIF Release 2.1 (June 2011) Split from Core 2.0 | + | -------- | ------- | + | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | | **Binding name** | `DisplayBinding` (`ver10/display.wsdl`) | - | **Operations** | [display.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/display.wsdl) | - | **Specification** | [Display.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Display.xml) | + | **Operations** | [display.wsdl](https://www.onvif.org/ver10/display.wsdl) | + | **Spec** | [Display](https://www.onvif.org/specs/srv/disp/ONVIF-Display-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/doorcontrol.py b/onvif/services/doorcontrol.py index 8dbe3672..3f13af43 100644 --- a/onvif/services/doorcontrol.py +++ b/onvif/services/doorcontrol.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class DoorControl(ONVIFService): """DoorControl service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 2.3 (May 2013) | | **Binding name** | `DoorControlBinding` (`ver10/pacs/doorcontrol.wsdl`) | - | **Operations** | [doorcontrol.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/pacs/doorcontrol.wsdl) | - | **Specification** | [DoorControl.xml](https://developer.onvif.org/pub/specs/branches/development/doc/DoorControl.xml) | + | **Operations** | [doorcontrol.wsdl](https://www.onvif.org/ver10/pacs/doorcontrol.wsdl) | + | **Spec** | [DoorControl](https://www.onvif.org/specs/srv/door/ONVIF-DoorControl-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/events/events.py b/onvif/services/events/events.py index 8cc94611..4415a9c2 100644 --- a/onvif/services/events/events.py +++ b/onvif/services/events/events.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class Events(ONVIFService): """Events service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Core | | **Binding name** | `EventBinding` (`ver10/events/wsdl/event-vs.wsdl`) | - | **Operations** | [event-vs.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/events/wsdl/event-vs.wsdl) | - | **Specification** | [Core.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Core.xml) | + | **Operations** | [event-vs.wsdl](https://www.onvif.org/ver10/events/wsdl/event-vs.wsdl) | + | **Spec** | [Core](https://www.onvif.org/specs/core/ONVIF-Core-Specification.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/events/notification.py b/onvif/services/events/notification.py index 20d2eeba..8e185d81 100644 --- a/onvif/services/events/notification.py +++ b/onvif/services/events/notification.py @@ -5,7 +5,6 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class Notification(ONVIFService): """WS-BaseNotification NotificationProducer service client. @@ -13,9 +12,10 @@ class Notification(ONVIFService): ONVIF devices for push-based event notification subscriptions. | Property | Details | - | --- | --- | - | **See** | ONVIF Core Specification, OASIS WS-BaseNotification Specification | + | -------- | ------- | + | **See** | ONVIF Core Spec, OASIS WS-BaseNotification Spec | | **Binding name** | `NotificationProducerBinding` (`ver10/events/wsdl/event-vs.wsdl`) | + | **Spec** | [Notification](https://docs.oasis-open.org/wsn/wsn-ws_base_notification-1.3-spec-os.htm#_Toc133735622) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/events/pausable_subscription.py b/onvif/services/events/pausable_subscription.py index 68a37dfe..0b992445 100644 --- a/onvif/services/events/pausable_subscription.py +++ b/onvif/services/events/pausable_subscription.py @@ -5,7 +5,6 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class PausableSubscription(ONVIFService): """WS-BaseNotification PausableSubscriptionManager service client. @@ -16,9 +15,10 @@ class PausableSubscription(ONVIFService): devices. | Property | Details | - | --- | --- | - | **See** | ONVIF Core Specification, OASIS WS-BaseNotification Specification | + | -------- | ------- | + | **See** | ONVIF Core Spec, OASIS WS-BaseNotification Spec | | **Binding name** | `PausableSubscriptionManagerBinding` (`ver10/events/wsdl/event-vs.wsdl`) | + | **Spec** | [PausableSubscription](https://docs.oasis-open.org/wsn/wsn-ws_base_notification-1.3-spec-os.htm#_Toc133735641) | !!! tip "Version History" - Available since [`>=v0.2.4`](/onvif-python/releases/#v0.2.4). diff --git a/onvif/services/events/pullpoint.py b/onvif/services/events/pullpoint.py index c3c65584..4ad140e5 100644 --- a/onvif/services/events/pullpoint.py +++ b/onvif/services/events/pullpoint.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class PullPoint(ONVIFService): """Events (PullPoint) service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Core | | **Binding name** | `PullPointSubscriptionBinding` (`ver10/events/wsdl/event-vs.wsdl`) | - | **Operations** | [event-vs.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/events/wsdl/event-vs.wsdl) | - | **Specification** | [Core.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Core.xml) | + | **Operations** | [event-vs.wsdl](https://www.onvif.org/ver10/events/wsdl/event-vs.wsdl) | + | **Spec** | [Core](https://www.onvif.org/specs/core/ONVIF-Core-Specification.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/events/subscription.py b/onvif/services/events/subscription.py index df15c923..46a68dd3 100644 --- a/onvif/services/events/subscription.py +++ b/onvif/services/events/subscription.py @@ -5,7 +5,6 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class Subscription(ONVIFService): """WS-BaseNotification SubscriptionManager service client. @@ -16,9 +15,10 @@ class Subscription(ONVIFService): when creating an event or pull point subscription. | Property | Details | - | --- | --- | - | **See** | ONVIF Core Specification, OASIS WS-BaseNotification Specification | + | -------- | ------- | + | **See** | ONVIF Core Spec, OASIS WS-BaseNotification Spec | | **Binding name** | `SubscriptionManagerBinding` (`ver10/events/wsdl/event-vs.wsdl`) | + | **Spec** | [Subscription](https://docs.oasis-open.org/wsn/wsn-ws_base_notification-1.3-spec-os.htm#_Toc133735638) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/imaging.py b/onvif/services/imaging.py index 72e75adb..08de4df5 100644 --- a/onvif/services/imaging.py +++ b/onvif/services/imaging.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class Imaging(ONVIFService): """Imaging service client. | Property | Details | - | --- | --- | - | **First introduced** | ONVIF Release 2.1 (June 2011) Split from Core 2.0 | + | -------- | ------- | + | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | | **Binding name** | `ImagingBinding` (`ver20/imaging/wsdl/imaging.wsdl`) | - | **Operations** | [imaging.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/imaging/wsdl/imaging.wsdl) | - | **Specification** | [Imaging.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Imaging.xml) | + | **Operations** | [imaging.wsdl](https://www.onvif.org/ver20/imaging/wsdl/imaging.wsdl) | + | **Spec** | [Imaging](https://www.onvif.org/specs/srv/img/ONVIF-Imaging-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/media.py b/onvif/services/media.py index c1b850be..1c6a970e 100644 --- a/onvif/services/media.py +++ b/onvif/services/media.py @@ -5,16 +5,16 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,too-many-public-methods class Media(ONVIFService): """Media service client. | Property | Details | - | --- | --- | - | **First introduced** | ONVIF Release 2.1 (June 2011) Split from Core 2.0 | + | -------- | ------- | + | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | | **Binding name** | `MediaBinding` (`ver10/media/wsdl/media.wsdl`) | - | **Operations** | [media.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/media/wsdl/media.wsdl) | - | **Specification** | [Media.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Media.xml) | + | **Operations** | [media.wsdl](https://www.onvif.org/ver10/media/wsdl/media.wsdl) | + | **Spec** | [Media](https://www.onvif.org/specs/srv/media/ONVIF-Media-Service-Spec.pdf) | + | **Data Format** | [Streaming](https://www.onvif.org/specs/stream/ONVIF-Streaming-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/media2.py b/onvif/services/media2.py index 775589f0..219e6f36 100644 --- a/onvif/services/media2.py +++ b/onvif/services/media2.py @@ -5,16 +5,16 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,too-many-public-methods class Media2(ONVIFService): """Media2 service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 2.61 (December 2015) | | **Binding name** | `Media2Binding` (`ver20/media/wsdl/media.wsdl`) | - | **Operations** | [media.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/media/wsdl/media.wsdl) | - | **Specification** | [Media2.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Media2.xml) | + | **Operations** | [media.wsdl](https://www.onvif.org/ver20/media/wsdl/media.wsdl) | + | **Spec** | [Media2](https://www.onvif.org/specs/srv/media/ONVIF-Media2-Service-Spec.pdf) | + | **Data Format** | [Streaming](https://www.onvif.org/specs/stream/ONVIF-Streaming-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/provisioning.py b/onvif/services/provisioning.py index 4e51d5a3..96330baa 100644 --- a/onvif/services/provisioning.py +++ b/onvif/services/provisioning.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,line-too-long class Provisioning(ONVIFService): """Provisioning service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 16.12 (December 2016) | | **Binding name** | `ProvisioningBinding` (`ver10/provisioning/wsdl/provisioning.wsdl`) | - | **Operations** | [provisioning.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/provisioning/wsdl/provisioning.wsdl) | - | **Specification** | [Provisioning.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Provisioning.xml) | + | **Operations** | [provisioning.wsdl](https://www.onvif.org/ver10/provisioning/wsdl/provisioning.wsdl) | + | **Spec** | [Provisioning](https://www.onvif.org/specs/srv/ptz/ONVIF-Provisioning-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/ptz.py b/onvif/services/ptz.py index 57582248..23c7f6a1 100644 --- a/onvif/services/ptz.py +++ b/onvif/services/ptz.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,too-many-public-methods class PTZ(ONVIFService): """PTZ service client. | Property | Details | - | --- | --- | - | **First introduced** | ONVIF Release 2.1 (June 2011) Split from Core 2.0 | + | -------- | ------- | + | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | | **Binding name** | `PTZBinding` (`ver20/ptz/wsdl/ptz.wsdl`) | - | **Operations** | [ptz.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/ptz/wsdl/ptz.wsdl) | - | **Specification** | [PTZ.xml](https://developer.onvif.org/pub/specs/branches/development/doc/PTZ.xml) | + | **Operations** | [ptz.wsdl](https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl) | + | **Spec** | [PTZ](https://www.onvif.org/specs/srv/ptz/ONVIF-PTZ-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/receiver.py b/onvif/services/receiver.py index f9ff2c11..4bf1cc33 100644 --- a/onvif/services/receiver.py +++ b/onvif/services/receiver.py @@ -5,16 +5,16 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class Receiver(ONVIFService): """Receiver service client. | Property | Details | - | --- | --- | - | **First introduced** | ONVIF Release 2.1 (June 2011) Split from Core 2.0 | + | -------- | ------- | + | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | | **Binding name** | `ReceiverBinding` (`ver10/receiver.wsdl`) | - | **Operations** | [receiver.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/receiver.wsdl) | - | **Specification** | [Receiver.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Receiver.xml) | + | **Operations** | [receiver.wsdl](https://www.onvif.org/ver10/receiver.wsdl) | + | **Spec** | [Receiver](https://www.onvif.org/specs/srv/rcv/ONVIF-Receiver-Service-Spec.pdf) | + | **Data Format** | [Streaming](https://www.onvif.org/specs/stream/ONVIF-Streaming-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/recording.py b/onvif/services/recording.py index fc958de3..19cff22b 100644 --- a/onvif/services/recording.py +++ b/onvif/services/recording.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,too-many-public-methods class Recording(ONVIFService): """Recording service client. | Property | Details | - | --- | --- | - | **First introduced** | ONVIF Release 2.1 (June 2011) Split from Core 2.0 | + | -------- | ------- | + | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | | **Binding name** | `RecordingBinding` (`ver10/recording.wsdl`) | - | **Operations** | [recording.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/recording.wsdl) | - | **Specification** | [RecordingControl.xml](https://developer.onvif.org/pub/specs/branches/development/doc/RecordingControl.xml) | + | **Operations** | [recording.wsdl](https://www.onvif.org/ver10/recording.wsdl) | + | **Spec** | [RecordingControl](https://www.onvif.org/specs/srv/rec/ONVIF-RecordingControl-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/replay.py b/onvif/services/replay.py index c1c2c8e8..33040b92 100644 --- a/onvif/services/replay.py +++ b/onvif/services/replay.py @@ -5,16 +5,16 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class Replay(ONVIFService): """Recording service client. | Property | Details | - | --- | --- | - | **First introduced** | ONVIF Release 2.1 (June 2011) Split from Core 2.0 | + | -------- | ------- | + | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | | **Binding name** | `ReplayBinding` (`ver10/replay.wsdl`) | - | **Operations** | [replay.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/replay.wsdl) | - | **Specification** | [Replay.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Replay.xml) | + | **Operations** | [replay.wsdl](https://www.onvif.org/ver10/replay.wsdl) | + | **Spec** | [ReplayControl](https://www.onvif.org/specs/srv/replay/ONVIF-ReplayControl-Service-Spec.pdf) | + | **Data Format** | [Streaming](https://www.onvif.org/specs/stream/ONVIF-Streaming-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/schedule.py b/onvif/services/schedule.py index b7578ae6..edcdfa6d 100644 --- a/onvif/services/schedule.py +++ b/onvif/services/schedule.py @@ -5,16 +5,16 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,redefined-outer-name +# pylint: disable=redefined-outer-name class Schedule(ONVIFService): """Schedule service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 2.6 (June 2015) | | **Binding name** | `ScheduleBinding` (`ver10/schedule/wsdl/schedule.wsdl`) | - | **Operations** | [schedule.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/schedule/wsdl/schedule.wsdl) | - | **Specification** | [Schedule.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Schedule.xml) | + | **Operations** | [schedule.wsdl](https://www.onvif.org/ver10/schedule/wsdl/schedule.wsdl) | + | **Spec** | [Scheduler](https://www.onvif.org/specs/srv/sched/ONVIF-Scheduler-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/search.py b/onvif/services/search.py index f75fec9d..7a529b74 100644 --- a/onvif/services/search.py +++ b/onvif/services/search.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class Search(ONVIFService): """Search service client. | Property | Details | - | --- | --- | - | **First introduced** | ONVIF Release 2.1 (June 2011) Split from Core 2.0 | + | -------- | ------- | + | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | | **Binding name** | `SearchBinding` (`ver10/search.wsdl`) | - | **Operations** | [search.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/search.wsdl) | - | **Specification** | [RecordingSearch.xml](https://developer.onvif.org/pub/specs/branches/development/doc/RecordingSearch.xml) | + | **Operations** | [search.wsdl](https://www.onvif.org/ver10/search.wsdl) | + | **Spec** | [RecordingSearch](https://www.onvif.org/specs/srv/rsrch/ONVIF-RecordingSearch-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/security/advancedsecurity.py b/onvif/services/security/advancedsecurity.py index 46dd1062..4748e28e 100644 --- a/onvif/services/security/advancedsecurity.py +++ b/onvif/services/security/advancedsecurity.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,too-few-public-methods,line-too-long class AdvancedSecurity(ONVIFService): """Security service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 2.4 (August 2013) | | **Binding name** | `AdvancedSecurityServiceBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | - | **Operations** | [advancedsecurity.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | - | **Specification** | [Security.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Security.xml) | + | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | + | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/security/authorizationserver.py b/onvif/services/security/authorizationserver.py index c7141ddd..a4759b79 100644 --- a/onvif/services/security/authorizationserver.py +++ b/onvif/services/security/authorizationserver.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,line-too-long class AuthorizationServer(ONVIFService): """Security (AuthorizationServer) service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 23.12 (December 2023) | | **Binding name** | `AuthorizationServerBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | - | **Operations** | [advancedsecurity.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | - | **Specification** | [Security.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Security.xml) | + | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | + | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/security/dot1x.py b/onvif/services/security/dot1x.py index 553f9839..1ce065b3 100644 --- a/onvif/services/security/dot1x.py +++ b/onvif/services/security/dot1x.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,line-too-long class Dot1X(ONVIFService): """Security (Dot1X) service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 16.06 (June 2016) | | **Binding name** | `Dot1XBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | - | **Operations** | [advancedsecurity.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | - | **Specification** | [Security.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Security.xml) | + | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | + | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/security/jwt.py b/onvif/services/security/jwt.py index a1fe41b6..3bef5d4d 100644 --- a/onvif/services/security/jwt.py +++ b/onvif/services/security/jwt.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,line-too-long class JWT(ONVIFService): """Security (JWT) service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 23.12 (December 2023) | | **Binding name** | `JWTBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | - | **Operations** | [advancedsecurity.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | - | **Specification** | [Security.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Security.xml) | + | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | + | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/security/keystore.py b/onvif/services/security/keystore.py index a505b184..c440b5ad 100644 --- a/onvif/services/security/keystore.py +++ b/onvif/services/security/keystore.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,too-many-public-methods,line-too-long class Keystore(ONVIFService): """Security (Keystore) service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 2.4 (August 2013) | | **Binding name** | `KeystoreBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | - | **Operations** | [advancedsecurity.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | - | **Specification** | [Security.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Security.xml) | + | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | + | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/security/mediasigning.py b/onvif/services/security/mediasigning.py index d5dc2bfe..0b9e6d28 100644 --- a/onvif/services/security/mediasigning.py +++ b/onvif/services/security/mediasigning.py @@ -5,16 +5,17 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,line-too-long class MediaSigning(ONVIFService): """Security (MediaSigning) service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 24.12 (December 2024) | | **Binding name** | `MediaSigningBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | - | **Operations** | [advancedsecurity.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | - | **Specification** | [Security.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Security.xml) | + | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | + | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | + | **Data Format** | [Media Signing](https://www.onvif.org/specs/stream/ONVIF-MediaSigning-Spec.pdf) | + | **File Format** | [Export File](https://www.onvif.org/specs/stream/ONVIF-ExportFileFormat-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): @@ -31,7 +32,7 @@ def AddMediaSigningCertificateAssignment(self, CertificationPathID): media signing, replacing the one that is provisioned during factory production. The leaf certificate in the chain and its associated private key shall be used - for signing media as described in the [Media Signing Specification]. This key + for signing media as described in the [Media Signing Spec]. This key and certificate is referred to as user provisioned key and certificate in that specification. diff --git a/onvif/services/security/tlsserver.py b/onvif/services/security/tlsserver.py index 7110f671..1b766cb2 100644 --- a/onvif/services/security/tlsserver.py +++ b/onvif/services/security/tlsserver.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name,line-too-long class TLSServer(ONVIFService): """Security (TLSServer) service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 2.4 (August 2013) | | **Binding name** | `TLSServerBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | - | **Operations** | [advancedsecurity.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | - | **Specification** | [Security.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Security.xml) | + | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | + | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/thermal.py b/onvif/services/thermal.py index 6e09b0da..3a7be2d4 100644 --- a/onvif/services/thermal.py +++ b/onvif/services/thermal.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class Thermal(ONVIFService): """Thermal service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 16.06 (June 2016) | | **Binding name** | `ThermalBinding` (`ver10/thermal/wsdl/thermal.wsdl`) | - | **Operations** | [thermal.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/thermal/wsdl/thermal.wsdl) | - | **Specification** | [Thermal.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Thermal.xml) | + | **Operations** | [thermal.wsdl](https://www.onvif.org/ver10/thermal/wsdl/thermal.wsdl) | + | **Spec** | [Thermal](https://www.onvif.org/specs/srv/thermal/ONVIF-Thermal-Service-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/uplink.py b/onvif/services/uplink.py index d0d806ae..64d7f8b7 100644 --- a/onvif/services/uplink.py +++ b/onvif/services/uplink.py @@ -5,16 +5,15 @@ from onvif.utils.wsdl import ONVIFWSDL -# pylint: disable=invalid-name class Uplink(ONVIFService): """Uplink service client. | Property | Details | - | --- | --- | + | -------- | ------- | | **First introduced** | ONVIF Release 18.12 (December 2018) | | **Binding name** | `UplinkBinding` (`ver10/uplink/wsdl/uplink.wsdl`) | - | **Operations** | [uplink.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/uplink/wsdl/uplink.wsdl) | - | **Specification** | [Uplink.xml](https://developer.onvif.org/pub/specs/branches/development/doc/Uplink.xml) | + | **Operations** | [uplink.wsdl](https://www.onvif.org/ver10/uplink/wsdl/uplink.wsdl) | + | **Spec** | [Uplink](https://www.onvif.org/specs/srv/uplink/ONVIF-Uplink-Spec.pdf) | """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/utils/discovery.py b/onvif/utils/discovery.py index 669708c8..ec350f44 100644 --- a/onvif/utils/discovery.py +++ b/onvif/utils/discovery.py @@ -124,7 +124,6 @@ def get_local_ip(self) -> str: self._local_ip = "" return self._local_ip - # pylint: disable=too-many-locals def discover( self, prefer_https: bool = False, search: str | None = None ) -> list[dict[str, Any]]: @@ -149,7 +148,7 @@ def discover( | `scopes` | `list[str]` | Device scopes. | | `xaddrs` | `list[str]` | All available XAddrs. | | `hostname` | `str | None` | Hostname of the device. | - | `date_time` | `dict[str, str]` | Device system date and time (`utc` and/or `local`); empty if none are available. | + | `date_time` | `dict[str, str]` | Device system date and time (`utc`, `local`); empty if none are available. | | `services` | `list[str]` | List of supported ONVIF services; empty if none are available. | !!! tip "Version History" diff --git a/onvif/utils/exceptions.py b/onvif/utils/exceptions.py index 3e8f4a7d..125f3fe5 100644 --- a/onvif/utils/exceptions.py +++ b/onvif/utils/exceptions.py @@ -6,8 +6,9 @@ from zeep.exceptions import Fault -# pylint: disable=line-too-long,too-many-locals,too-many-nested-blocks,too-many-branches,too-many-statements +# pylint: disable=too-many-nested-blocks,too-many-branches class ONVIFOperationException(Exception): + # pylint: disable=line-too-long """Enhanced exception wrapper for ONVIF operation failures. This exception provides detailed error information including operation name, @@ -87,6 +88,7 @@ class ONVIFOperationException(Exception): - `zeep.exceptions.Fault`: Base SOAP fault exception - `requests.exceptions.RequestException`: Base HTTP error """ + # pylint: enable=line-too-long def __init__(self, operation: str, original_exception: Exception): self.operation = operation diff --git a/onvif/utils/service.py b/onvif/utils/service.py index 676c739a..cc6c2007 100644 --- a/onvif/utils/service.py +++ b/onvif/utils/service.py @@ -302,7 +302,8 @@ def desc(self, method_name: str) -> dict: available_methods = self.operations() raise ValueError( f"Method '{method_name}' not found in service. " - f"Available methods: {', '.join(available_methods[:5])}{'...' if len(available_methods) > 5 else ''}" + f"Available methods: {', '.join(available_methods[:5])}" + f"{'...' if len(available_methods) > 5 else ''}" ) # Extract service name from binding for context diff --git a/onvif/utils/zeep.py b/onvif/utils/zeep.py index 847a699c..6d3364b4 100644 --- a/onvif/utils/zeep.py +++ b/onvif/utils/zeep.py @@ -14,7 +14,7 @@ logger.addHandler(logging.NullHandler()) -# pylint: disable=too-many-branches,too-many-statements,too-many-nested-blocks,too-many-locals,too-many-return-statements +# pylint: disable=too-many-branches,too-many-nested-blocks,too-many-return-statements class ZeepPatcher: """Utility for patching zeep SOAP library to handle ONVIF `xsd:any` fields. diff --git a/tests/cli/test_cli_helper_execution.py b/tests/cli/test_cli_helper_execution.py index 803eabb5..533555e5 100644 --- a/tests/cli/test_cli_helper_execution.py +++ b/tests/cli/test_cli_helper_execution.py @@ -11,13 +11,13 @@ ) -class FakeService: # pylint: disable=too-few-public-methods +class FakeService: """Minimal fake service used to test CLI command execution.""" def __init__(self, result=None): self.result = result - def GetProfiles(self, **kwargs): # pylint: disable=invalid-name + def GetProfiles(self, **kwargs): """Return a predictable result for GetProfiles.""" return self.result or { "method": "GetProfiles", @@ -25,7 +25,7 @@ def GetProfiles(self, **kwargs): # pylint: disable=invalid-name } -class FakeClient: # pylint: disable=too-few-public-methods +class FakeClient: """Minimal fake client used to provide services to CLI command execution.""" def __init__(self, service=None): @@ -208,11 +208,11 @@ def test_execute_command_unknown_method(): def test_execute_command_preserves_method_attribute_error_as_value_error(): """Test that a method lookup AttributeError raises ValueError.""" - class Service: # pylint: disable=too-few-public-methods + class Service: """Service with property.""" @property - def GetProfiles(self): # pylint: disable=invalid-name + def GetProfiles(self): """Unavailable method.""" raise AttributeError("method unavailable") diff --git a/tests/cli/test_cli_helper_files.py b/tests/cli/test_cli_helper_files.py index 558646ec..c92ea4ff 100644 --- a/tests/cli/test_cli_helper_files.py +++ b/tests/cli/test_cli_helper_files.py @@ -77,7 +77,7 @@ def test_dict(self): def test_regular_object(self): """Test serialization of a regular object.""" - class Camera: # pylint: disable=too-few-public-methods + class Camera: """Simple camera object for serialization testing.""" def __init__(self): @@ -95,7 +95,7 @@ def __init__(self): def test_regular_object_nested(self): """Test serialization of a regular object with nested values.""" - class Camera: # pylint: disable=too-few-public-methods + class Camera: """Simple camera object with nested settings.""" def __init__(self): @@ -118,7 +118,7 @@ def __init__(self): def test_regular_object_uses_dir_when_dict_empty(self): """Test serialization using public attributes when __dict__ is empty.""" - class Camera: # pylint: disable=too-few-public-methods + class Camera: """Camera object exposing a property instead of instance attributes.""" @property @@ -135,7 +135,7 @@ def name(self): def test_regular_object_skips_callable_attributes(self): """Test that callable attributes are excluded from serialization.""" - class Camera: # pylint: disable=too-few-public-methods + class Camera: """Camera object containing a callable attribute.""" def __init__(self): @@ -154,7 +154,7 @@ def method(self): def test_zeep_object(self): """Test serialization of a Zeep-like object.""" - class ZeepObject: # pylint: disable=too-few-public-methods + class ZeepObject: """Simple object that mimics a Zeep object.""" _xsd_type = type( @@ -181,7 +181,7 @@ class ZeepObject: # pylint: disable=too-few-public-methods def test_zeep_object_nested(self): """Test serialization of a nested Zeep-like object.""" - class Profile: # pylint: disable=too-few-public-methods + class Profile: """Simple profile object that mimics a Zeep object.""" _xsd_type = type( @@ -200,7 +200,7 @@ class Profile: # pylint: disable=too-few-public-methods profile = Profile() - class Camera: # pylint: disable=too-few-public-methods + class Camera: """Simple camera object containing a nested profile.""" _xsd_type = type( @@ -225,7 +225,7 @@ class Camera: # pylint: disable=too-few-public-methods def test_zeep_object_skips_missing_element(self): """Test that missing Zeep elements are skipped.""" - class ZeepObject: # pylint: disable=too-few-public-methods + class ZeepObject: """Simple Zeep-like object with a missing element.""" _xsd_type = type( @@ -250,7 +250,7 @@ class ZeepObject: # pylint: disable=too-few-public-methods def test_zeep_object_skips_none_element(self): """Test that Zeep elements with None values are skipped.""" - class ZeepObject: # pylint: disable=too-few-public-methods + class ZeepObject: """Simple Zeep-like object containing a None element.""" _xsd_type = type( @@ -270,7 +270,7 @@ class ZeepObject: # pylint: disable=too-few-public-methods def test_zeep_object_includes_regular_attributes(self): """Test that regular attributes are included with Zeep elements.""" - class ZeepObject: # pylint: disable=too-few-public-methods + class ZeepObject: """Simple Zeep-like object with an additional attribute.""" _xsd_type = type( @@ -294,7 +294,7 @@ class ZeepObject: # pylint: disable=too-few-public-methods def test_zeep_object_does_not_duplicate_xsd_element(self): """Test that XSD elements are not duplicated as regular attributes.""" - class ZeepObject: # pylint: disable=too-few-public-methods + class ZeepObject: """Simple Zeep-like object with an XSD element.""" _xsd_type = type( @@ -316,7 +316,7 @@ class ZeepObject: # pylint: disable=too-few-public-methods def test_value_1(self): """Test serialization of an object containing _value_1.""" - class ZeepValue: # pylint: disable=too-few-public-methods + class ZeepValue: """Simple object containing a Zeep _value_1 attribute.""" __slots__ = ("_value_1",) @@ -335,7 +335,7 @@ def __init__(self): def test_value_1_nested(self): """Test serialization of nested values stored in _value_1.""" - class ZeepValue: # pylint: disable=too-few-public-methods + class ZeepValue: """Simple object containing nested Zeep values.""" __slots__ = ("_value_1",) @@ -354,7 +354,7 @@ def __init__(self): def test_fallback_to_vars(self): """Test fallback serialization for objects without serializable attributes.""" - class CustomObject: # pylint: disable=too-few-public-methods + class CustomObject: """Simple object that falls back to string conversion.""" __slots__ = () @@ -621,7 +621,6 @@ def test_text_debug_only_operation(self, tmp_path): assert "SOAP Response:" not in content -# pylint: disable=too-few-public-methods class TestSaveOutputToFileExtensionHandling: """Tests for output file extension handling.""" diff --git a/tests/cli/test_cli_helper_products.py b/tests/cli/test_cli_helper_products.py index b32d9b55..0a5a789c 100644 --- a/tests/cli/test_cli_helper_products.py +++ b/tests/cli/test_cli_helper_products.py @@ -359,7 +359,6 @@ def test_truncates_wide_content(self): assert result[index] < original_widths[index] -# pylint: disable=too-few-public-methods class TestFormatDateWidth: """Tests for formatting dates for table display.""" @@ -394,7 +393,6 @@ def test_format_date(self, value, expected): assert _format_date_width(value) == expected -# pylint: disable=too-few-public-methods class TestPrintDataHeader: """Tests for printing the product table header.""" diff --git a/tests/cli/test_cli_helper_wsdl_parser.py b/tests/cli/test_cli_helper_wsdl_parser.py index b0261326..31b48f78 100644 --- a/tests/cli/test_cli_helper_wsdl_parser.py +++ b/tests/cli/test_cli_helper_wsdl_parser.py @@ -37,7 +37,6 @@ def make_service(wsdl_path, **methods): return service -# pylint: disable=invalid-name class TestGetMethodDocumentation: """Tests for extracting WSDL documentation and method parameters.""" diff --git a/tests/cli/test_cli_interactive_navigation.py b/tests/cli/test_cli_interactive_navigation.py index 364ae171..d132d0e3 100644 --- a/tests/cli/test_cli_interactive_navigation.py +++ b/tests/cli/test_cli_interactive_navigation.py @@ -605,7 +605,7 @@ def test_do_enter_service_does_not_print_traceback_without_debug( print_exc.assert_not_called() -class TestNavigationCommandsExitService: # pylint: disable=too-few-public-methods +class TestNavigationCommandsExitService: """Test exit service alias.""" def test_do_exit_service_delegates_to_do_up(self): diff --git a/tests/cli/test_cli_interactive_shell.py b/tests/cli/test_cli_interactive_shell.py index 48da7431..0260a7ef 100644 --- a/tests/cli/test_cli_interactive_shell.py +++ b/tests/cli/test_cli_interactive_shell.py @@ -263,7 +263,7 @@ def test_handles_invalid_device_information(self): """Verify that invalid device data falls back to ``Unknown``.""" shell = object.__new__(InteractiveShell) - class InvalidDeviceData: # pylint: disable=too-few-public-methods + class InvalidDeviceData: """Device data that raises an error when accessed.""" def get(self, _key, _default): diff --git a/tests/cli/test_cli_interactive_utils.py b/tests/cli/test_cli_interactive_utils.py index 2524b776..5ed6c191 100644 --- a/tests/cli/test_cli_interactive_utils.py +++ b/tests/cli/test_cli_interactive_utils.py @@ -84,7 +84,7 @@ def create_utilities(): return utilities -class TestShellUtilitiesInitialization: # pylint: disable=too-few-public-methods +class TestShellUtilitiesInitialization: """Test health-check initialization.""" def test_initialize_health_check_creates_event(self): diff --git a/tests/cli/test_cli_utils.py b/tests/cli/test_cli_utils.py index f980bee3..2f537dcf 100644 --- a/tests/cli/test_cli_utils.py +++ b/tests/cli/test_cli_utils.py @@ -259,7 +259,6 @@ def test_no_required_args(self, service_name): assert get_service_required_args(service_name) is None -# pylint: disable=too-few-public-methods class TestGetServiceMethods: """Tests for extracting callable public service methods.""" @@ -334,7 +333,7 @@ def test_windows_success(self): def test_windows_failure(self, exception): """Test Windows ANSI detection failure.""" - class FakeWindll: # pylint: disable=too-few-public-methods + class FakeWindll: """Fake ctypes.windll for testing.""" @property diff --git a/tests/services/base_service_test.py b/tests/services/base_service_test.py index 739da2cd..1e46194d 100644 --- a/tests/services/base_service_test.py +++ b/tests/services/base_service_test.py @@ -195,7 +195,8 @@ def test_wsdl_operations_not_empty(self): f"No WSDL operations found. Check if:\n" f"1. WSDL file exists at: {self.WSDL_PATH_COMPONENTS}\n" f"2. BINDING_NAME '{self.BINDING_NAME}' is correct\n" - f"3. NAMESPACE_PREFIX '{self.NAMESPACE_PREFIX}' and SERVICE_NAMESPACE '{self.SERVICE_NAMESPACE}' are correct\n" + f"3. NAMESPACE_PREFIX '{self.NAMESPACE_PREFIX}' and " + f"SERVICE_NAMESPACE '{self.SERVICE_NAMESPACE}' are correct\n" f"4. WSDL parsing is working correctly" ) @@ -273,7 +274,8 @@ def test_method_parameters_match_wsdl(self): if known_issues: error_msg = "Parameter name issues found:\n" + "\n".join( [ - f" {issue['operation']}: '{issue['method_param']}' should be '{issue['expected_wsdl_param']}' ({issue['issue']})" + f" {issue['operation']}: '{issue['method_param']}' should be " + f"'{issue['expected_wsdl_param']}' ({issue['issue']})" for issue in known_issues ] ) @@ -382,7 +384,7 @@ def _edit_distance(self, s1: str, s2: str) -> int: return previous_row[-1] - def test_operator_call_usage( # pylint: disable=too-many-locals,too-many-branches,too-many-nested-blocks + def test_operator_call_usage( # pylint: disable=too-many-branches,too-many-nested-blocks self, ): """Test that all methods correctly call self.operator.call().""" @@ -470,7 +472,7 @@ def test_legacy_call_uses_legacy_operation(self): "http://www.onvif.org/ver20/media/wsdl/SetEQPresetConfiguration" ) - class FakeBinding: # pylint: disable=too-few-public-methods + class FakeBinding: """Minimal binding implementation for testing legacy operations.""" def __init__(self): @@ -482,7 +484,7 @@ def get(self, name): """Return an operation by name.""" return self._operations.get(name) - class FakeService: # pylint: disable=too-few-public-methods + class FakeService: """Minimal service proxy that resolves operations from the binding.""" def __init__(self, binding): @@ -553,7 +555,7 @@ def test_no_extra_methods(self): not extra_methods ), f"Extra methods found that are not in WSDL: {extra_methods}" - # pylint: disable=too-many-locals,too-many-branches,too-many-nested-blocks + # pylint: disable=too-many-branches,too-many-nested-blocks def test_parameter_forwarding_for_all_methods(self): """Test that all method parameters are correctly forwarded to operator.call().""" diff --git a/tests/services/test_jwt.py b/tests/services/test_jwt.py index 1fd88265..9af143b6 100644 --- a/tests/services/test_jwt.py +++ b/tests/services/test_jwt.py @@ -32,7 +32,11 @@ def test_specific_methods_implementation(self): "Configuration": { "TokenIssuer": "https://issuer.example.com", "Audience": "onvif-device", - "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...\n-----END PUBLIC KEY-----", + "PublicKey": ( + "-----BEGIN PUBLIC KEY-----\n" + "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...\n" + "-----END PUBLIC KEY-----" + ), } }, }, diff --git a/tests/test_client.py b/tests/test_client.py index 0fb97868..78bebfd2 100644 --- a/tests/test_client.py +++ b/tests/test_client.py @@ -324,7 +324,7 @@ def test_get_xaddr_capabilities_lookup_error(self, mock_onvif_client): ) -class BrokenCapabilities: # pylint: disable=too-few-public-methods +class BrokenCapabilities: """BrokenCapabilities.""" def __getattr__(self, _name): diff --git a/tests/test_core.py b/tests/test_core.py index b0acad92..b37fd42c 100644 --- a/tests/test_core.py +++ b/tests/test_core.py @@ -91,7 +91,6 @@ def test_xml_capture_plugin_can_be_reset(self): assert plugin.last_operation is None -# pylint: disable=too-few-public-methods class TestCoreErrorHandling: """Test errors crossing core component boundaries.""" diff --git a/tests/test_operator.py b/tests/test_operator.py index 11f8cfc7..372d35a0 100644 --- a/tests/test_operator.py +++ b/tests/test_operator.py @@ -828,7 +828,7 @@ def test_create_type_raises_when_all_lookup_methods_fail(self): operator.create_type("GetProfiles") -# pylint: disable=invalid-name,unnecessary-pass,too-few-public-methods +# pylint: disable=unnecessary-pass class TestInitializeNestedTypes: """Tests for the _initialize_nested_types method of ONVIFOperator.""" diff --git a/tests/utilities/test_exceptions.py b/tests/utilities/test_exceptions.py index 9ccd81a1..05acee29 100644 --- a/tests/utilities/test_exceptions.py +++ b/tests/utilities/test_exceptions.py @@ -27,10 +27,10 @@ def __init__(self, code=None, message=None, detail=None, subcodes=None): import requests except ImportError: # Create mock requests module for testing - class MockRequestsModule: # pylint: disable=too-few-public-methods + class MockRequestsModule: """MockRequestsModule.""" - class exceptions: # pylint: disable=invalid-name,too-few-public-methods + class exceptions: """exceptions.""" class RequestException(Exception): @@ -187,7 +187,7 @@ def test_soap_fault_with_detail_children(self): def test_soap_fault_with_non_iterable_detail(self): """Test SOAP fault detail represented by a non-iterable object.""" - class NonIterableDetail: # pylint: disable=too-few-public-methods + class NonIterableDetail: """NonIterableDetail.""" def __str__(self): diff --git a/tests/utilities/test_plugins.py b/tests/utilities/test_plugins.py index 4d809131..743a4837 100644 --- a/tests/utilities/test_plugins.py +++ b/tests/utilities/test_plugins.py @@ -185,7 +185,6 @@ def test_get_extracted_texts_returns_empty_list_for_zero_count(self): assert parser.get_extracted_texts("topic", 0) == [] -# pylint: disable=too-many-public-methods class TestXMLCapturePlugin: """Tests for the XMLCapturePlugin.""" diff --git a/tests/utilities/test_service.py b/tests/utilities/test_service.py index f2450bd9..052abf2b 100644 --- a/tests/utilities/test_service.py +++ b/tests/utilities/test_service.py @@ -9,7 +9,6 @@ from onvif.utils.service import ONVIFService, _is_zeep_object -# pylint: disable=invalid-name class TestService(ONVIFService): """Concrete test implementation of ONVIFService.""" @@ -37,7 +36,7 @@ def _private_method(self): return "private" -# pylint: disable=invalid-name,unnecessary-pass +# pylint: disable=unnecessary-pass class DescriptionService(ONVIFService): """Concrete test implementation of ONVIFService with method documentation.""" @@ -289,7 +288,7 @@ def test_zeep_object_attribute_error_is_wrapped(self, service): """Test that AttributeError raised during Zeep object conversion is wrapped in ONVIFOperationException.""" - class Params: # pylint: disable=too-few-public-methods + class Params: """Mock Zeep object with _xsd_type.elements that raises AttributeError.""" _xsd_type = SimpleNamespace(elements=[("Missing", object())]) diff --git a/tests/utilities/test_wsdl.py b/tests/utilities/test_wsdl.py index 66a5b94d..3da5a579 100644 --- a/tests/utilities/test_wsdl.py +++ b/tests/utilities/test_wsdl.py @@ -176,7 +176,7 @@ def test_definitions_have_required_fields(self, monkeypatch): assert {"path", "binding", "namespace"} <= definition.keys() -# pylint: disable=protected-access,too-few-public-methods +# pylint: disable=protected-access class TestEnsureWsdlMapInitialized: """Test lazy WSDL map initialization.""" diff --git a/tests/utilities/test_zeep.py b/tests/utilities/test_zeep.py index 9f1b1c57..de45bcab 100644 --- a/tests/utilities/test_zeep.py +++ b/tests/utilities/test_zeep.py @@ -10,7 +10,7 @@ from onvif.utils.zeep import ZeepPatcher -class ZeepObject: # pylint: disable=too-few-public-methods +class ZeepObject: """Simple object that mimics a Zeep object.""" def __init__(self, values): @@ -18,7 +18,7 @@ def __init__(self, values): self.__values__ = values -class PlainObject: # pylint: disable=too-few-public-methods +class PlainObject: """Simple object that only exposes normal object attributes.""" def __init__(self): @@ -28,7 +28,7 @@ def __init__(self): self._private = "ignored" -class NestedObject: # pylint: disable=too-few-public-methods +class NestedObject: """Simple object used for nested object conversion tests.""" def __init__(self, value): @@ -486,7 +486,7 @@ def test_converts_nested_object_dict(self): def test_returns_objects_without_supported_attributes(self): """Test returning objects that expose neither values nor dict state.""" - class SlotObject: # pylint: disable=too-few-public-methods + class SlotObject: """Object without a __dict__.""" __slots__ = ("value",) @@ -500,7 +500,6 @@ def __init__(self): assert ZeepPatcher._zeep_object_to_dict(obj) is obj -# pylint: disable=invalid-name class TestFlattenXsdAnyFields: """Tests for flattening xsd:any fields.""" @@ -521,7 +520,7 @@ def test_returns_dict_unchanged(self): def test_returns_object_without_dict_unchanged(self): """Test that objects without __dict__ are returned unchanged.""" - class SlotObject: # pylint: disable=too-few-public-methods + class SlotObject: """Object without a __dict__.""" __slots__ = () From afa1d11e80f7274a39c613bf258239186e00b96b Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Fri, 9 Oct 2026 02:34:44 +0700 Subject: [PATCH 11/37] docs: Update docstrings to include version tracking (#165) --- onvif/client.py | 16 ++++-- onvif/mappings.py | 2 +- onvif/operator.py | 28 ++++++--- onvif/services/devicemgmt.py | 15 ++++- .../services/events/pausable_subscription.py | 2 +- onvif/services/media2.py | 30 ++++++++-- onvif/services/recording.py | 18 +++++- onvif/services/search.py | 24 ++++++-- onvif/utils/discovery.py | 36 +++++++----- onvif/utils/error_handlers.py | 19 +++++-- onvif/utils/exceptions.py | 4 +- onvif/utils/plugins.py | 57 +++++++++---------- onvif/utils/service.py | 18 +++++- onvif/utils/wsdl.py | 39 ++++++++++--- onvif/utils/zeep.py | 22 ++++--- 15 files changed, 231 insertions(+), 99 deletions(-) diff --git a/onvif/client.py b/onvif/client.py index 0a43fddb..c88888b9 100644 --- a/onvif/client.py +++ b/onvif/client.py @@ -1,4 +1,4 @@ -"""ONVIFClient: High-level ONVIF client for interacting with ONVIF-compliant devices.""" +"""High-level ONVIF client for interacting with ONVIF-compliant devices.""" from __future__ import annotations @@ -116,11 +116,14 @@ class ONVIFClient: services (list): List of available services from `GetServices` response capabilities (CompoundValue): Device capabilities from `GetCapabilities` response (fallback) xml_plugin (XMLCapturePlugin): XML capture plugin for debugging (if `capture_xml=True`) - plugins (list[Plugin] | None): List of user-provided Zeep plugins (if any) wsdl_dir (str | None): Custom WSDL directory path (if provided) + plugins (list[Plugin] | None): List of user-provided Zeep plugins (if any) !!! tip "Version History" - - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release). + - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release) + - Added in [`>=v0.0.6`](/onvif-python/releases/#v0.0.6): `xml_plugin` + - Added in [`>=v0.1.0`](/onvif-python/releases/#v0.1.0): `wsdl_dir` + - Added in [`>=v0.4.3`](/onvif-python/releases/#v0.4.3): `plugins` """ def __init__( @@ -589,7 +592,12 @@ def subscription(self, SubscriptionRef) -> Subscription: @service def pausable_subscription(self, SubscriptionRef) -> PausableSubscription: - """Access the PausableSubscription service.""" + """ + Access the PausableSubscription service. + + !!! tip "Version History" + - Available since [`>=v0.2.4`](/onvif-python/releases/#v0.2.4) + """ logger.debug("Initializing PausableSubscription service") return self._get_subscription_service( SubscriptionRef, diff --git a/onvif/mappings.py b/onvif/mappings.py index 3d0197be..2892001f 100644 --- a/onvif/mappings.py +++ b/onvif/mappings.py @@ -15,7 +15,7 @@ class WSDLDefinition(TypedDict): WSDLMap = dict[str, dict[str, WSDLDefinition]] -ONVIF_WSDL_MAP: Final[dict[str, dict[str, WSDLDefinition]]] = { +ONVIF_WSDL_MAP: Final[WSDLMap] = { "devicemgmt": { "ver10": { "filename": "devicemgmt.wsdl", diff --git a/onvif/operator.py b/onvif/operator.py index ed139584..06fd808c 100644 --- a/onvif/operator.py +++ b/onvif/operator.py @@ -1,4 +1,4 @@ -"""ONVIFOperator: Low-level ONVIF service operator using Zeep SOAP client.""" +"""Low-level ONVIF service operator using Zeep SOAP client.""" from __future__ import annotations @@ -38,7 +38,7 @@ class CacheMode(Enum): DB (Literal['db']): Persistent SQLite caching across process restarts. !!! tip "Version History" - - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release). + - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release) - Removed in [`>=v0.4.0`](/onvif-python/releases/#v0.4.0): `CacheMode.ALL` """ @@ -99,7 +99,7 @@ class ONVIFOperator: WSDL loading, service binding, authentication, caching, and error handling. !!! danger - ``ONVIFOperator`` is typically used internally by service classes + ``ONVIFOperator`` is typically **used internally** by service classes such as Device, Media, and PTZ, and is not intended to be instantiated directly by end users. @@ -120,7 +120,8 @@ class ONVIFOperator: service_name (str): Name of the ONVIF service (e.g., "Device", "Media") !!! tip "Version History" - - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release). + - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release) + - No version tracking for attribute changes because this class is used internally """ def __init__( @@ -272,6 +273,9 @@ def call(self, method: str, *args, **kwargs) -> Any: errors gracefully. It automatically flattens `xsd:any` fields in the response when `apply_patch` is enabled. + !!! tip "Version History" + - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release) + Args: method (str): Name of the ONVIF operation to call (e.g., "GetDeviceInformation") *args (Any): Positional arguments to pass to the operation @@ -321,18 +325,21 @@ def legacy_call( and response definitions while overriding the operation name and SOAP action. + !!! tip "Version History" + - Available since [`>=v0.4.3`](/onvif-python/releases/#v0.4.3) + Args: - legacy_method: Name of the legacy ONVIF operation. - current_method: Name of the operation defined by the current WSDL. - *args (Any): Positional arguments to pass to the operation. - **kwargs (Any): Keyword arguments to pass to the operation. + legacy_method: Name of the legacy ONVIF operation + current_method: Name of the operation defined by the current WSDL + *args (Any): Positional arguments to pass to the operation + **kwargs (Any): Keyword arguments to pass to the operation Returns: The operation result with `xsd:any` fields flattened if `apply_patch=True` Raises: ONVIFOperationException: If either operation cannot be resolved or - the SOAP operation fails. + the SOAP operation fails """ logger.debug( "Calling legacy ONVIF method: %s.%s -> %s", @@ -399,6 +406,9 @@ def create_type(self, type_name: str) -> Any: Recursively initializes nested complex types so that fields like TimeZone, DateTime, Date, and Time are properly instantiated as objects rather than None. + !!! tip "Version History" + - Available since [`>=v0.1.9`](/onvif-python/releases/#v0.1.9) + Args: type_name (str): Name of the type to create (e.g., 'SetHostname', 'SetIPAddressFilter') diff --git a/onvif/services/devicemgmt.py b/onvif/services/devicemgmt.py index 7022355c..f344f27c 100644 --- a/onvif/services/devicemgmt.py +++ b/onvif/services/devicemgmt.py @@ -311,6 +311,9 @@ def GetUserRoles(self, UserRole=None): Whenever an editable user level is passed in the request, information only about that level is returned. + + !!! tip "Version History" + - Available since [`>=v0.2.7`](/onvif-python/releases/#v0.2.7) """ return self.operator.call("GetUserRoles", UserRole=UserRole) @@ -319,11 +322,18 @@ def SetUserRole(self, UserRole): If the level passed in UserRole already exists in the device, its configuration is overwritten. Otherwise, a new editable user level is created. + + !!! tip "Version History" + - Available since [`>=v0.2.7`](/onvif-python/releases/#v0.2.7) """ return self.operator.call("SetUserRole", UserRole=UserRole) def DeleteUserRole(self, UserRole): - """This operation deletes an editable user level in the device.""" + """This operation deletes an editable user level in the device. + + !!! tip "Version History" + - Available since [`>=v0.2.7`](/onvif-python/releases/#v0.2.7) + """ return self.operator.call("DeleteUserRole", UserRole=UserRole) def GetUsers(self): @@ -896,6 +906,9 @@ def UpgradeFirmware(self, Version): as all the parameters of the Uplink and Security service unchanged, so that it can connect to the cloud. Additionally a firmware upgrade shall not change user credentials. + + !!! tip "Version History" + - Available since [`>=v0.2.6`](/onvif-python/releases/#v0.2.6) """ return self.operator.call("UpgradeFirmware", Version=Version) diff --git a/onvif/services/events/pausable_subscription.py b/onvif/services/events/pausable_subscription.py index 0b992445..94ae1275 100644 --- a/onvif/services/events/pausable_subscription.py +++ b/onvif/services/events/pausable_subscription.py @@ -21,7 +21,7 @@ class PausableSubscription(ONVIFService): | **Spec** | [PausableSubscription](https://docs.oasis-open.org/wsn/wsn-ws_base_notification-1.3-spec-os.htm#_Toc133735641) | !!! tip "Version History" - - Available since [`>=v0.2.4`](/onvif-python/releases/#v0.2.4). + - Available since [`>=v0.2.4`](/onvif-python/releases/#v0.2.4) """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/media2.py b/onvif/services/media2.py index 219e6f36..77ee28e5 100644 --- a/onvif/services/media2.py +++ b/onvif/services/media2.py @@ -304,7 +304,11 @@ def SetEQPreset(self, Configuration): ) def SetEQPresetConfiguration(self, Configuration): - """This command is to configure Audio EQPreset.""" + """This command is to configure Audio EQPreset. + + !!! tip "Version History" + - Available since [`>=v0.4.3`](/onvif-python/releases/#v0.4.3) + """ return self.operator.call( "SetEQPresetConfiguration", Configuration=Configuration ) @@ -651,7 +655,11 @@ def PlayAudioClip(self, Token, Play, AudioOutputToken=None, RepeatCycles=None): def AddTTSAudioClip(self, Configuration, TTSConfiguration, Token=None): """This operation sends a text and its configuration to device that supports TTS function, so that device could convert the text into an audio clip and play it - according to audio clip Configuration and TTS Configuration.""" + according to audio clip Configuration and TTS Configuration. + + !!! tip "Version History" + - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + """ return self.operator.call( "AddTTSAudioClip", Token=Token, @@ -666,21 +674,33 @@ def GetPlayingAudioClips(self): def GetMulticastAudioDecoderConfigurationOptions(self, ConfigurationToken=None): """This operation gets the available options for the MulticastAudioDecoder - configuration.""" + configuration. + + !!! tip "Version History" + - Available since [`>=v0.2.6`](/onvif-python/releases/#v0.2.6) + """ return self.operator.call( "GetMulticastAudioDecoderConfigurationOptions", ConfigurationToken=ConfigurationToken, ) def GetMulticastAudioDecoderConfigurations(self, ConfigurationToken=None): - """This operation gets the list of multicast audio decoder configurations.""" + """This operation gets the list of multicast audio decoder configurations. + + !!! tip "Version History" + - Available since [`>=v0.2.6`](/onvif-python/releases/#v0.2.6) + """ return self.operator.call( "GetMulticastAudioDecoderConfigurations", ConfigurationToken=ConfigurationToken, ) def SetMulticastAudioDecoderConfiguration(self, Configuration): - """This operation sets the MulticastAudioDecoderConfiguration.""" + """This operation sets the MulticastAudioDecoderConfiguration. + + !!! tip "Version History" + - Available since [`>=v0.2.6`](/onvif-python/releases/#v0.2.6) + """ return self.operator.call( "SetMulticastAudioDecoderConfiguration", Configuration=Configuration ) diff --git a/onvif/services/recording.py b/onvif/services/recording.py index 19cff22b..140435f1 100644 --- a/onvif/services/recording.py +++ b/onvif/services/recording.py @@ -255,7 +255,11 @@ def OverrideSegmentDuration( ) def ListRecordedSegments(self, Time, RecordingToken, MaxResults=None): - """Lists available recorded segments related to the specified RecordingToken.""" + """Lists available recorded segments related to the specified RecordingToken. + + !!! tip "Version History" + - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + """ return self.operator.call( "ListRecordedSegments", Time=Time, @@ -272,7 +276,11 @@ def ExportRecordedSegments( Track=None, ): """Exports the selected recorded segments (from existing recorded data) to the - storage attached to the given recording configuration.""" + storage attached to the given recording configuration. + + !!! tip "Version History" + - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + """ return self.operator.call( "ExportRecordedSegments", Time=Time, @@ -283,7 +291,11 @@ def ExportRecordedSegments( ) def StopExportRecordedSegments(self, OperationToken): - """Stops the selected ExportRecordedSegments operation.""" + """Stops the selected ExportRecordedSegments operation. + + !!! tip "Version History" + - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + """ return self.operator.call( "StopExportRecordedSegments", OperationToken=OperationToken ) diff --git a/onvif/services/search.py b/onvif/services/search.py index 7a529b74..f14f67d8 100644 --- a/onvif/services/search.py +++ b/onvif/services/search.py @@ -350,7 +350,11 @@ def SearchImageByNL( MaxMatches=None, ): """Starts a natural language search session and specifies the search - parameters.""" + parameters. + + !!! tip "Version History" + - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + """ return self.operator.call( "SearchImageByNL", StartPoint=StartPoint, @@ -365,7 +369,11 @@ def SearchImageByNL( def GetNLSearchResults( self, SearchToken, MinResults=None, MaxResults=None, WaitTime=None ): - """Gets results from a natural language search session.""" + """Gets results from a natural language search session. + + !!! tip "Version History" + - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + """ return self.operator.call( "GetNLSearchResults", SearchToken=SearchToken, @@ -384,7 +392,11 @@ def SearchImageByImage( TargetImageData=None, MaxMatches=None, ): - """Starts an image-based search session and specifies the search parameters.""" + """Starts an image-based search session and specifies the search parameters. + + !!! tip "Version History" + - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + """ return self.operator.call( "SearchImageByImage", StartPoint=StartPoint, @@ -399,7 +411,11 @@ def SearchImageByImage( def GetImageSearchResults( self, SearchToken, MinResults=None, MaxResults=None, WaitTime=None ): - """Gets results from an image-based search session.""" + """Gets results from an image-based search session. + + !!! tip "Version History" + - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + """ return self.operator.call( "GetImageSearchResults", SearchToken=SearchToken, diff --git a/onvif/utils/discovery.py b/onvif/utils/discovery.py index ec350f44..4e3c1903 100644 --- a/onvif/utils/discovery.py +++ b/onvif/utils/discovery.py @@ -1,4 +1,4 @@ -"""ONVIFDiscovery: Discover ONVIF-compliant devices on the local network using WS-Discovery protocol.""" +"""Discover ONVIF-compliant devices on the local network using WS-Discovery protocol.""" from __future__ import annotations @@ -38,7 +38,7 @@ class ONVIFDiscovery: interface (str | None): Network interface IP to bind to (default: auto-detect) !!! tip "Version History" - - Available since [`>=v0.1.6`](/onvif-python/releases/#v0.1.6). + - Available since [`>=v0.1.6`](/onvif-python/releases/#v0.1.6) """ WS_DISCOVERY_PORT: int = 3702 @@ -88,8 +88,11 @@ def __init__( def get_local_ip(self) -> str: """Get local network interface IP address. + !!! tip "Version History" + - Available since [`>=v0.1.6`](/onvif-python/releases/#v0.1.6) + Returns: - str: Local IP address + Local IP address """ if self._local_ip is not None: return self._local_ip @@ -129,30 +132,33 @@ def discover( ) -> list[dict[str, Any]]: """Discover ONVIF devices on the network. + !!! tip "Version History" + - Available since [`>=v0.1.6`](/onvif-python/releases/#v0.1.6) + Args: prefer_https (bool): If True, prioritize HTTPS XAddrs when available search (str | None): Optional search term to filter devices by types or scopes (case-insensitive) Returns: - List of discovered devices (as dict); empty if none are available. + List of discovered devices (as dict); empty if none are available !!! abstract "Device dict" | Key | Type | Description | | --- | ---- | ----------- | - | `host` | `str` | Device IP address or hostname. | - | `port` | `int` | Device port number. | - | `use_https` | `bool` | Whether the device supports HTTPS. | - | `epr` | `str` | Endpoint reference. | - | `types` | `list[str]` | Device types. | - | `scopes` | `list[str]` | Device scopes. | - | `xaddrs` | `list[str]` | All available XAddrs. | - | `hostname` | `str | None` | Hostname of the device. | - | `date_time` | `dict[str, str]` | Device system date and time (`utc`, `local`); empty if none are available. | - | `services` | `list[str]` | List of supported ONVIF services; empty if none are available. | + | `host` | `str` | Device IP address or hostname | + | `port` | `int` | Device port number | + | `use_https` | `bool` | Whether the device supports HTTPS | + | `epr` | `str` | Endpoint reference | + | `types` | `list[str]` | Device types | + | `scopes` | `list[str]` | Device scopes | + | `xaddrs` | `list[str]` | All available XAddrs | + | `hostname` | `str | None` | Hostname of the device | + | `date_time` | `dict[str, str]` | System date and time (`utc`, `local`); empty if none are available | + | `services` | `list[str]` | List of supported ONVIF services; empty if none are available | !!! tip "Version History" - - Added in [`>=v0.4.0`](/onvif-python/releases/#v0.4.0): `hostname`, `date_time`, and `services`. + - Added in [`>=v0.4.0`](/onvif-python/releases/#v0.4.0): `hostname`, `date_time`, and `services` """ local_ip = self.get_local_ip() logger.info("Starting ONVIF device discovery (timeout: %ss)", self.timeout) diff --git a/onvif/utils/error_handlers.py b/onvif/utils/error_handlers.py index f63f1c8c..ee1bd29e 100644 --- a/onvif/utils/error_handlers.py +++ b/onvif/utils/error_handlers.py @@ -11,8 +11,8 @@ cases. !!! tip "Version History" - - Available since [`>=v0.0.7`](/onvif-python/releases/#v0.0.7) as `ONVIFErrorHandler`. - - Refactor to module since [`>=v0.4.0`](/onvif-python/releases/#v0.4.0). + - Available since [`>=v0.0.7`](/onvif-python/releases/#v0.0.7) as `ONVIFErrorHandler` + - Refactor to module since [`>=v0.4.0`](/onvif-python/releases/#v0.4.0) !!! abstract "Features" - Detect `ActionNotSupported` SOAP faults @@ -55,12 +55,15 @@ def is_action_not_supported(exception: ONVIFOperationException | Fault) -> bool: """ Check whether an exception is caused by an `ActionNotSupported` SOAP fault. + !!! tip "Version History" + - Available since [`>=v0.4.0`](/onvif-python/releases/#v0.4.0) + Args: exception: The exception to inspect. Can be an [`ONVIFOperationException`](onvif_exception.md) or a raw `zeep.exceptions.Fault`. Returns: - `True` if the exception contains an `ActionNotSupported` SOAP fault, `False` otherwise. + `True` if the exception contains an `ActionNotSupported` SOAP fault, `False` otherwise Example: ```python linenums="1" @@ -116,6 +119,9 @@ def safe_call( """ Safely call an ONVIF operation with graceful error handling. + !!! tip "Version History" + - Available since [`>=v0.4.0`](/onvif-python/releases/#v0.4.0) + Args: func (Callable): The callable that performs the ONVIF operation. default (Any | None): The value to return when the operation is unsupported and @@ -131,7 +137,7 @@ def safe_call( Returns: The result returned by `func`, or `default` when the operation is - unsupported and `handle_unsupported` is enabled. + unsupported and `handle_unsupported` is enabled Raises: ONVIFOperationException: If the operation fails for a reason other @@ -185,12 +191,15 @@ def safe_call( def ignore_unsupported(func: Callable) -> Any | None: """Decorator to ignore `ActionNotSupported` SOAP faults. + !!! tip "Version History" + - Available since [`>=v0.4.0`](/onvif-python/releases/#v0.4.0) + Args: func (Callable): The function to decorate. The function may accept positional and keyword arguments. Returns: - A wrapped function that returns `None` when an `ActionNotSupported` fault occurs. + A wrapped function that returns `None` when an `ActionNotSupported` fault occurs Raises: ONVIFOperationException: If the decorated function fails for a reason diff --git a/onvif/utils/exceptions.py b/onvif/utils/exceptions.py index 125f3fe5..7e2a8368 100644 --- a/onvif/utils/exceptions.py +++ b/onvif/utils/exceptions.py @@ -1,4 +1,4 @@ -"""ONVIFOperationException: Enhanced exception wrapper for ONVIF operation failures.""" +"""Enhanced exception wrapper for ONVIF operation failures.""" from __future__ import annotations @@ -21,7 +21,7 @@ class ONVIFOperationException(Exception): original_exception (Exception): The underlying exception that was raised !!! tip "Version History" - - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release). + - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release) ## Error Categories diff --git a/onvif/utils/plugins.py b/onvif/utils/plugins.py index b96467b3..26e68583 100644 --- a/onvif/utils/plugins.py +++ b/onvif/utils/plugins.py @@ -25,16 +25,14 @@ class ONVIFParser(Plugin): `simpleContent` elements with attributes. Args: - extract_xpaths: Dictionary mapping extraction names to XPath expressions. + extract_xpaths: Dictionary mapping extraction names to XPath expressions Attributes: extract_xpaths: XPath expressions used to extract elements from SOAP - responses. - _extracted_elements: Extracted element texts from the most recent SOAP - response, grouped by extraction name. + responses !!! tip "Version History" - - Available since [`>=v0.2.2`](/onvif-python/releases/#v0.2.2). + - Available since [`>=v0.2.2`](/onvif-python/releases/#v0.2.2) ??? example "Usage" ```python linenums="1" @@ -73,7 +71,7 @@ def __init__(self, extract_xpaths: dict[str, str]): Args: extract_xpaths: Dictionary mapping names to XPath expressions. - XPath expressions will be used to find elements in SOAP response. + XPath expressions will be used to find elements in SOAP response. Example: ```python @@ -104,9 +102,9 @@ def ingress( always contains values from the most recently processed SOAP response. Args: - envelope: Raw SOAP response envelope as an `lxml.etree.Element`. - http_headers: HTTP response headers returned by the device. - operation: Zeep operation associated with the SOAP response. + envelope: Raw SOAP response envelope as an `lxml.etree.Element` + http_headers: HTTP response headers returned by the device + operation: Zeep operation associated with the SOAP response Returns: A tuple containing the unchanged ``envelope`` and ``http_headers``. @@ -170,8 +168,8 @@ class XMLCapturePlugin(Plugin): history (list[dict[str, Any]]): All captured requests/responses with metadata !!! tip "Version History" - - Available since [`>=v0.0.6`](/onvif-python/releases/#v0.0.6). - - Moved to `plugins` since [`>=v0.4.0`](/onvif-python/releases/#v0.4.0). + - Available since [`>=v0.0.6`](/onvif-python/releases/#v0.0.6) + - Moved to `plugins` since [`>=v0.4.0`](/onvif-python/releases/#v0.4.0) !!! abstract "The plugin automatically captures" - Outgoing SOAP requests (`egress`) @@ -279,13 +277,13 @@ def egress( hook only observes the outgoing request and does not modify it. Args: - envelope: SOAP request envelope that is about to be sent. - http_headers: HTTP request headers that will be sent with the request. - operation: Zeep operation being invoked. - binding_options: Zeep binding options for the current request. + envelope: SOAP request envelope that is about to be sent + http_headers: HTTP request headers that will be sent with the request + operation: Zeep operation being invoked + binding_options: Zeep binding options for the current request Returns: - A tuple containing the unchanged ``envelope`` and ``http_headers``. + A tuple containing the unchanged ``envelope`` and ``http_headers`` """ logger.debug( "Capturing outgoing SOAP request for operation: %s", operation.name @@ -331,12 +329,12 @@ def ingress( hook only observes the incoming response and does not modify it. Args: - envelope: Raw SOAP response envelope received from the device. - http_headers: HTTP response headers returned by the device. - operation: Zeep operation associated with the response. + envelope: Raw SOAP response envelope received from the device + http_headers: HTTP response headers returned by the device + operation: Zeep operation associated with the response Returns: - A tuple containing the unchanged ``envelope`` and ``http_headers``. + A tuple containing the unchanged ``envelope`` and ``http_headers`` """ logger.debug( "Capturing incoming SOAP response for operation: %s", operation.name @@ -437,14 +435,13 @@ class ReferenceParametersPlugin(Plugin): Attributes: reference_parameters: XML elements to inject into outgoing SOAP - headers. + headers !!! tip "Version History" - - Available since [`>=v0.3.1`](/onvif-python/releases/#v0.3.1). + - Available since [`>=v0.3.1`](/onvif-python/releases/#v0.3.1) !!! note - - The plugin supports both SOAP 1.1 and SOAP 1.2 envelope namespaces. + The plugin supports both SOAP 1.1 and SOAP 1.2 envelope namespaces """ SOAP_NAMESPACES = ( @@ -472,16 +469,16 @@ def egress( XML elements remain unchanged and can safely be reused. Args: - envelope: SOAP request envelope that is about to be sent. - http_headers: HTTP request headers that will be sent with the request. - operation: Zeep operation being invoked. - binding_options: Zeep binding options for the current request. + envelope: SOAP request envelope that is about to be sent + http_headers: HTTP request headers that will be sent with the request + operation: Zeep operation being invoked + binding_options: Zeep binding options for the current request Returns: - A tuple containing the modified ``envelope`` and the unchanged ``http_headers``. + A tuple containing the modified ``envelope`` and the unchanged ``http_headers`` Raises: - RuntimeError: If the SOAP envelope uses an unsupported SOAP namespace. + RuntimeError: If the SOAP envelope uses an unsupported SOAP namespace """ soap_namespace = etree.QName(envelope).namespace diff --git a/onvif/utils/service.py b/onvif/utils/service.py index cc6c2007..0344f8f7 100644 --- a/onvif/utils/service.py +++ b/onvif/utils/service.py @@ -1,4 +1,4 @@ -"""ONVIFService: Base class for all ONVIF service implementations.""" +"""Base class for all ONVIF service implementations.""" from __future__ import annotations @@ -67,7 +67,7 @@ class ONVIFService: [`Media`](../services/media.md), [`PTZ`](../services/ptz.md), etc.). !!! tip "Version History" - - Available since [`>=v0.1.8`](/onvif-python/releases/#v0.1.8). + - Available since [`>=v0.1.8`](/onvif-python/releases/#v0.1.8) !!! danger "All service classes inherit from `ONVIFService` to ensure" - Consistent exception handling across all ONVIF operations @@ -167,6 +167,9 @@ def type(self, type_name: str) -> Any: """ Create and return an instance of the specified ONVIF type. + !!! tip "Version History" + - Available since [`>=v0.1.9`](/onvif-python/releases/#v0.1.9) + Args: type_name (str): Name of the type to create (e.g., 'SetHostname', 'SetIPAddressFilter') @@ -214,6 +217,9 @@ def type(self, type_name: str) -> Any: def operations(self) -> list[str] | list: """List all available operations for this service. + !!! tip "Version History" + - Available since [`>=v0.2.0`](/onvif-python/releases/#v0.2.0) + Returns: List of operation names that can be used with `type()` method @@ -262,11 +268,14 @@ def desc(self, method_name: str) -> dict: """ Get documentation and parameter information for a specific operation/method. + !!! tip "Version History" + - Available since [`>=v0.2.0`](/onvif-python/releases/#v0.2.0) + Args: method_name (str): Name of the method to describe (e.g., 'GetDeviceInformation', 'SetHostname') Returns: - Operation documentation dictionary. + Operation documentation dictionary !!! abstract "Documentation dict" @@ -376,6 +385,9 @@ def to_dict(self, zeep_object: Any) -> dict: """ Convert a zeep object (result from ONVIF operation) to Python dictionary. + !!! tip "Version History" + - Available since [`>=v0.2.9`](/onvif-python/releases/#v0.2.9) + Args: zeep_object (Any): The zeep object returned from ONVIF operations diff --git a/onvif/utils/wsdl.py b/onvif/utils/wsdl.py index 420ca381..1f712b59 100644 --- a/onvif/utils/wsdl.py +++ b/onvif/utils/wsdl.py @@ -1,4 +1,4 @@ -"""ONVIFWSDL: WSDL file manager for ONVIF services with support for built-in and custom WSDL dir.""" +"""WSDL file manager for ONVIF services with support for built-in and custom WSDL dir.""" from __future__ import annotations @@ -25,10 +25,9 @@ class ONVIFWSDL: Attributes: BASE_DIR (str): Default base directory for WSDL files (Built-in) WSDL_MAP (dict[str, dict[str, Any]] | None): Will be initialized when first accessed - _custom_wsdl_dir (str | None): Global custom WSDL directory !!! tip "Version History" - - Available since [`>=v0.1.0`](/onvif-python/releases/#v0.1.0). + - Available since [`>=v0.1.0`](/onvif-python/releases/#v0.1.0) !!! abstract "Features" - Centralized WSDL definition mapping for all ONVIF services @@ -71,6 +70,7 @@ class ONVIFWSDL: !!! question "Service Definition Format" Each service has a definition containing: + - `filename` : WSDL file name - `path`: Full path to WSDL file - `binding`: SOAP binding name (e.g., "DeviceBinding") - `namespace`: XML namespace URI (e.g., "http://www.onvif.org/ver10/device/wsdl") @@ -101,9 +101,12 @@ class ONVIFWSDL: _custom_wsdl_dir: str | None = None @classmethod - def set_custom_wsdl_dir(cls, custom_dir) -> None: + def set_custom_wsdl_dir(cls, custom_dir: str) -> None: """Set global custom WSDL directory for all services. + !!! tip "Version History" + - Available since [`>=v0.1.0`](/onvif-python/releases/#v0.1.0) + Args: custom_dir (str): Path to directory containing custom WSDL files @@ -122,8 +125,11 @@ def set_custom_wsdl_dir(cls, custom_dir) -> None: def get_custom_wsdl_dir(cls) -> str | None: """Get current global custom WSDL directory. + !!! tip "Version History" + - Available since [`>=v0.1.0`](/onvif-python/releases/#v0.1.0) + Returns: - str or None: Current custom WSDL directory, or None if using built-in + Current custom WSDL directory, or None if using built-in Example: ```python linenums="1" @@ -139,6 +145,9 @@ def get_custom_wsdl_dir(cls) -> str | None: def clear_custom_wsdl_dir(cls) -> None: """Clear custom WSDL directory, revert to built-in WSDLs. + !!! tip "Version History" + - Available since [`>=v0.1.0`](/onvif-python/releases/#v0.1.0) + Example: ```python linenums="1" from onvif import ONVIFWSDL @@ -152,13 +161,13 @@ def clear_custom_wsdl_dir(cls) -> None: cls._custom_wsdl_dir = None @classmethod - def _get_base_dir(cls, custom_wsdl_dir=None) -> str | Any: + def _get_base_dir(cls, custom_wsdl_dir: str | None = None) -> str | Any: """Get the base WSDL directory, using custom directory if provided. This method implements the priority chain for WSDL directory resolution. Args: - custom_wsdl_dir (str, optional): Per-call custom directory + custom_wsdl_dir (str | None): Per-call custom directory Returns: str: Resolved WSDL base directory path @@ -187,7 +196,7 @@ def _get_wsdl_map( The structure differs based on whether custom WSDLs are used. Args: - custom_wsdl_dir (str, optional): Custom WSDL directory path + custom_wsdl_dir (str | None): Custom WSDL directory path Returns: dict: Complete WSDL mapping for all services @@ -196,6 +205,7 @@ def _get_wsdl_map( { "{service_name}": { "{version}": { + "filename": "service.wsdl", "path": "/full/path/to/service.wsdl", "binding": "ServiceBinding", "namespace": "http://www.onvif.org/ver10/service/wsdl" @@ -248,7 +258,11 @@ def _ensure_wsdl_map_initialized(cls) -> None: @classmethod def get_wsdl_map(cls) -> dict[str, dict[str, Any]]: - """Get the complete WSDL map for all services.""" + """Get the complete WSDL map for all services. + + !!! tip "Version History" + - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + """ cls._ensure_wsdl_map_initialized() if cls.WSDL_MAP is None: @@ -265,6 +279,9 @@ def get_definition( Returns complete WSDL definition including file path, SOAP binding name, and XML namespace for the requested service and version. + !!! tip "Version History" + - Available since [`>=v0.1.0`](/onvif-python/releases/#v0.1.0) + Args: service (str): Service name (e.g., "devicemgmt", "media", "ptz"). version (str): ONVIF version (default: "ver10"). @@ -279,10 +296,14 @@ def get_definition( | Key | Type | Description | | --- | ---- | ----------- | + | `filename` | `str` | WSDL file name | | `path` | `str | None` | Full path to WSDL file | | `binding` | `str` | SOAP binding name | | `namespace` | `str` | XML namespace URI | + !!! tip "Version History" + - Added in [`>=v0.4.5`](/onvif-python/releases/#v0.4.5): `filename` + ??? note - Most services use ver10, some newer ones use ver20 - Media has both ver10 (media) and ver20 (media2) diff --git a/onvif/utils/zeep.py b/onvif/utils/zeep.py index 6d3364b4..5df4c221 100644 --- a/onvif/utils/zeep.py +++ b/onvif/utils/zeep.py @@ -1,4 +1,4 @@ -"""ZeepPatcher: Patch zeep SOAP library to handle ONVIF `xsd:any` fields.""" +"""Patch zeep SOAP library to handle ONVIF `xsd:any` fields.""" from __future__ import annotations @@ -23,12 +23,8 @@ class ZeepPatcher: elements, making them difficult to work with. The patch converts them into structured dictionaries with proper type conversion. - Attributes: - _original_parse_xmlelements (Callable[..., Any]): Backup of original zeep method - _is_patched (bool): Current patch status - !!! tip "Version History" - - Available since [`>=v0.0.4`](/onvif-python/releases/#v0.0.4). + - Available since [`>=v0.0.4`](/onvif-python/releases/#v0.0.4) !!! failure "The Problem" ONVIF uses `xsd:any` extensively for extensibility. By default, zeep doesn't @@ -387,6 +383,9 @@ def flatten_xsd_any_fields(obj, _visited=None) -> Any: This handles all `xsd:any` occurrences (`_value_1`, `_value_2`, `_value_3`, etc.), not just the first one. + !!! tip "Version History" + - Available since [`>=v0.0.4`](/onvif-python/releases/#v0.0.4) + Args: obj (XsdAny): The zeep object to process _visited (XsdAny): Set of visited object IDs to prevent infinite recursion @@ -632,6 +631,9 @@ def apply_patch(cls): This enables better parsing of `xsd:any` fields in ONVIF SOAP responses. Should be called once at application startup. + !!! tip "Version History" + - Available since [`>=v0.0.4`](/onvif-python/releases/#v0.0.4) + Example: ```python linenums="1" from onvif import ZeepPatcher @@ -654,6 +656,9 @@ def remove_patch(cls): Reverts zeep to its original behavior. Useful for testing or debugging. + !!! tip "Version History" + - Available since [`>=v0.0.4`](/onvif-python/releases/#v0.0.4) + Example: ```python linenums="1" from onvif import ZeepPatcher @@ -673,8 +678,11 @@ def remove_patch(cls): def is_patched(cls) -> bool: """Check if the patch is currently applied. + !!! tip "Version History" + - Available since [`>=v0.0.4`](/onvif-python/releases/#v0.0.4) + Returns: - `True` if patch is active, `False` otherwise. + `True` if patch is active, `False` otherwise Example: ```python linenums="1" From 739412a148abb8095b3138074abf7c5ebac590df Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Fri, 9 Oct 2026 02:41:37 +0700 Subject: [PATCH 12/37] feat(docs): Add hook to exclude mkdocstrings source blocks from search (#166) --- docs/hooks.py | 6 ++++++ mkdocs.yml | 3 +++ 2 files changed, 9 insertions(+) create mode 100644 docs/hooks.py diff --git a/docs/hooks.py b/docs/hooks.py new file mode 100644 index 00000000..615df332 --- /dev/null +++ b/docs/hooks.py @@ -0,0 +1,6 @@ +def on_page_content(html, page, config, files): + """Exclude mkdocstrings source blocks from Material search.""" + return html.replace( + '
', + '
', + ) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index fbc743bf..c5c943fd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -178,4 +178,7 @@ extra_javascript: - javascripts/github-releases.js - javascripts/external-links.js +hooks: + - docs/hooks.py + copyright: Copyright © 2026  —  Nirsimetri Technologies® \ No newline at end of file From 05d421e5da28e41139e2d1dc91de5f5b0937929a Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Tue, 13 Oct 2026 00:06:48 +0700 Subject: [PATCH 13/37] ci: Update fetch-depth in documentation preview workflow (#168) --- .github/workflows/documentation-preview.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/documentation-preview.yml b/.github/workflows/documentation-preview.yml index 5aba2d79..c6370736 100644 --- a/.github/workflows/documentation-preview.yml +++ b/.github/workflows/documentation-preview.yml @@ -29,6 +29,8 @@ jobs: steps: - name: Checkout uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + fetch-depth: 0 - name: Set up Python if: github.event.action != 'closed' From b6372776c89cd7d4ac8fffbb529e65e62bdc3093 Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Sat, 17 Oct 2026 18:50:35 +0700 Subject: [PATCH 14/37] ci: Update python ver in docs workflow and install docs dependencies (#177) --- .github/workflows/documentation.yml | 2 +- .github/workflows/python-app.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 4fcc1a2d..24dc03f2 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -26,7 +26,7 @@ jobs: - name: Set up Python uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 with: - python-version: "3.12" + python-version: "3.x" - name: Install documentation dependencies run: | diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml index 308a1a75..a6803960 100644 --- a/.github/workflows/python-app.yml +++ b/.github/workflows/python-app.yml @@ -45,7 +45,7 @@ jobs: - name: Install project run: | python -m pip install --upgrade pip - pip install ".[dev]" + pip install ".[dev,docs]" - name: Check formatting with black run: black --check . From 169b1e02e5522687f8b3965a5d41d2cbdba2b57f Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Sat, 17 Oct 2026 19:38:48 +0700 Subject: [PATCH 15/37] chore: Improve formatting and grammar in NOTICE file --- NOTICE | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/NOTICE b/NOTICE index c44680df..9cb4bfe2 100644 --- a/NOTICE +++ b/NOTICE @@ -1,11 +1,20 @@ -This project is an independent open-source implementation of the ONVIF (https://www.onvif.org) specifications. It is not affiliated with, endorsed by, or sponsored by ONVIF or its member companies. +This project is an independent open-source implementation of the +ONVIF (https://www.onvif.org) specifications. It is not affiliated with, +endorsed by, or sponsored by ONVIF or its member companies. -- The name “ONVIF” and the ONVIF logo are registered trademarks of the ONVIF organization. -- Any references to ONVIF within this project are made strictly for the purpose of describing interoperability with ONVIF-compliant devices and services. -- Use of the ONVIF trademark in this repository is solely nominative and does not imply any partnership, certification, or official status. +- The name “ONVIF” is a registered trademarks of the ONVIF organization. +- Any references to ONVIF within this project are made strictly for the purpose of + describing interoperability with ONVIF-compliant devices and services. +- Use of the ONVIF trademark in this repository is solely nominative and does not imply + any partnership, certification, or official status. - This project includes WSDL/XSD/HTML files from the official ONVIF specifications. - These files are © ONVIF and are redistributed here for interoperability purposes. -- The WSDL files in the https://github.com/nirsimetri/onvif-python/tree/main/onvif/wsdl folder are distributed under the ONVIF Contributor License Agreement and Apache License 2.0. See https://github.com/nirsimetri/onvif-python/tree/main/onvif/wsdl/LICENSE for details. +- The WSDL files in the https://github.com/nirsimetri/onvif-python/tree/main/onvif/wsdl + folder are distributed under the Apache License 2.0. See + https://github.com/nirsimetri/onvif-python/tree/main/onvif/wsdl/LICENSE for details. - All rights to the ONVIF specifications are reserved by ONVIF. -If you require certified ONVIF-compliant devices or clients, please refer to the official https://www.onvif.org/conformant-products. For authoritative reference and the latest official ONVIF specifications, please consult the https://www.onvif.org/profiles/specifications/specification-history. \ No newline at end of file +If you require certified ONVIF-compliant devices or clients, please refer to +the official https://www.onvif.org/conformant-products. For authoritative +reference and the latest official ONVIF specifications, please consult the +https://www.onvif.org/profiles/specifications/specification-history. From f566fc1e7eddc3dc7aadea5ca01cb89be91d5994 Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Sat, 17 Oct 2026 19:41:06 +0700 Subject: [PATCH 16/37] docs: Documentation overhaul (#167) --- README.md | 78 ++- docs/api/core/index.md | 22 + docs/api/core/onvif_client.md | 12 +- docs/api/core/onvif_discovery.md | 7 - docs/api/core/onvif_operator.md | 9 +- docs/api/exceptions/index.md | 22 + docs/api/exceptions/onvif_error_handlers.md | 9 +- docs/api/exceptions/onvif_exception.md | 6 +- docs/api/index.md | 46 ++ .../{analytics.md => analytics/index.md} | 0 .../services/{ => analytics}/ruleengine.md | 0 .../services/{events.md => events/index.md} | 0 .../api/services/{ => events}/notification.md | 0 .../{ => events}/pausable_subscription.md | 0 docs/api/services/{ => events}/pullpoint.md | 0 .../api/services/{ => events}/subscription.md | 0 docs/api/services/index.md | 158 ++++++ .../{ => security}/authorizationserver.md | 0 docs/api/services/{ => security}/dot1x.md | 0 .../index.md} | 0 docs/api/services/{ => security}/jwt.md | 0 docs/api/services/{ => security}/keystore.md | 2 +- .../services/{ => security}/mediasigning.md | 0 docs/api/services/{ => security}/tlsserver.md | 0 docs/api/utilities/cache_mode.md | 9 +- docs/api/utilities/index.md | 46 ++ docs/api/utilities/onvif_discovery.md | 15 + docs/api/utilities/onvif_service.md | 9 +- docs/api/utilities/onvif_wsdl.md | 9 +- docs/api/utilities/plugins.md | 12 +- docs/api/utilities/zeep_patcher.md | 9 +- docs/{philosophy.md => approach.md} | 8 +- docs/core/onvif_discovery.md | 1 - docs/hooks/griffe_extensions.py | 35 ++ docs/{hooks.py => hooks/misc.py} | 7 +- docs/hooks/shortcodes.py | 408 ++++++++++++++++ docs/index.md | 85 +++- docs/installation.md | 14 +- docs/javascripts/external-links.js | 58 ++- docs/javascripts/extra.js | 34 ++ docs/javascripts/github-releases.js | 2 +- docs/javascripts/section-flash.js | 112 +++++ docs/legal/license.md | 5 + docs/legal/{legal_notice.md => notice.md} | 5 + docs/llms.txt | 220 +++++++++ docs/{core => main}/onvif_cli.md | 49 +- docs/{core => main}/onvif_client.md | 39 +- docs/overrides/.icons/material/analytics.svg | 1 + .../overrides/.icons/material/app-badging.svg | 1 + docs/overrides/.icons/material/automation.svg | 1 + docs/overrides/.icons/material/category.svg | 1 + .../.icons/material/linked-services.svg | 1 + .../overrides/.icons/material/my-location.svg | 1 + .../.icons/material/network-node.svg | 1 + docs/overrides/.icons/material/sensors.svg | 1 + docs/overrides/404.html | 25 + docs/overrides/main.html | 4 +- docs/overrides/partials/comments.html | 70 +++ docs/project/contributing.md | 182 +++---- docs/project/external.md | 23 +- docs/project/roadmap.md | 14 +- docs/project/used_by.md | 6 + docs/quick_start.md | 34 +- docs/references/implemented_services.md | 243 ++++++++-- docs/references/index.md | 32 ++ docs/references/service_bindings.md | 8 + docs/references/service_discovery.md | 23 +- docs/references/supported_profiles.md | 6 + docs/stylesheets/extra.css | 449 +++++++++++++++++- docs/utilities/helper_methods.md | 28 +- mkdocs.yml | 198 ++++++-- onvif/client.py | 265 ++++++++--- onvif/operator.py | 49 +- onvif/services/accesscontrol.py | 8 +- onvif/services/accessrules.py | 8 +- onvif/services/actionengine.py | 8 +- onvif/services/analytics/analytics.py | 9 +- onvif/services/analytics/ruleengine.py | 8 +- onvif/services/analyticsdevice.py | 12 +- onvif/services/appmgmt.py | 8 +- onvif/services/authenticationbehavior.py | 8 +- onvif/services/credential.py | 8 +- onvif/services/deviceio.py | 8 +- onvif/services/devicemgmt.py | 41 +- onvif/services/display.py | 8 +- onvif/services/doorcontrol.py | 8 +- onvif/services/events/events.py | 9 +- onvif/services/events/notification.py | 6 +- .../services/events/pausable_subscription.py | 9 +- onvif/services/events/pullpoint.py | 8 +- onvif/services/events/subscription.py | 6 +- onvif/services/imaging.py | 9 +- onvif/services/media.py | 9 +- onvif/services/media2.py | 42 +- onvif/services/provisioning.py | 8 +- onvif/services/ptz.py | 9 +- onvif/services/receiver.py | 8 +- onvif/services/recording.py | 28 +- onvif/services/replay.py | 8 +- onvif/services/schedule.py | 8 +- onvif/services/search.py | 34 +- onvif/services/security/advancedsecurity.py | 8 +- .../services/security/authorizationserver.py | 8 +- onvif/services/security/dot1x.py | 8 +- onvif/services/security/jwt.py | 8 +- onvif/services/security/keystore.py | 8 +- onvif/services/security/mediasigning.py | 8 +- onvif/services/security/tlsserver.py | 8 +- onvif/services/thermal.py | 8 +- onvif/services/uplink.py | 8 +- onvif/utils/discovery.py | 32 +- onvif/utils/error_handlers.py | 31 +- onvif/utils/exceptions.py | 9 +- onvif/utils/plugins.py | 374 ++++++++------- onvif/utils/service.py | 65 ++- onvif/utils/wsdl.py | 60 ++- onvif/utils/zeep.py | 43 +- pyproject.toml | 3 + 118 files changed, 3479 insertions(+), 782 deletions(-) create mode 100644 docs/api/core/index.md delete mode 100644 docs/api/core/onvif_discovery.md create mode 100644 docs/api/exceptions/index.md create mode 100644 docs/api/index.md rename docs/api/services/{analytics.md => analytics/index.md} (100%) rename docs/api/services/{ => analytics}/ruleengine.md (100%) rename docs/api/services/{events.md => events/index.md} (100%) rename docs/api/services/{ => events}/notification.md (100%) rename docs/api/services/{ => events}/pausable_subscription.md (100%) rename docs/api/services/{ => events}/pullpoint.md (100%) rename docs/api/services/{ => events}/subscription.md (100%) create mode 100644 docs/api/services/index.md rename docs/api/services/{ => security}/authorizationserver.md (100%) rename docs/api/services/{ => security}/dot1x.md (100%) rename docs/api/services/{advancedsecurity.md => security/index.md} (100%) rename docs/api/services/{ => security}/jwt.md (100%) rename docs/api/services/{ => security}/keystore.md (90%) rename docs/api/services/{ => security}/mediasigning.md (100%) rename docs/api/services/{ => security}/tlsserver.md (100%) create mode 100644 docs/api/utilities/index.md create mode 100644 docs/api/utilities/onvif_discovery.md rename docs/{philosophy.md => approach.md} (95%) delete mode 100644 docs/core/onvif_discovery.md create mode 100644 docs/hooks/griffe_extensions.py rename docs/{hooks.py => hooks/misc.py} (64%) create mode 100644 docs/hooks/shortcodes.py create mode 100644 docs/javascripts/extra.js create mode 100644 docs/javascripts/section-flash.js rename docs/legal/{legal_notice.md => notice.md} (98%) create mode 100644 docs/llms.txt rename docs/{core => main}/onvif_cli.md (94%) rename docs/{core => main}/onvif_client.md (84%) create mode 100644 docs/overrides/.icons/material/analytics.svg create mode 100644 docs/overrides/.icons/material/app-badging.svg create mode 100644 docs/overrides/.icons/material/automation.svg create mode 100644 docs/overrides/.icons/material/category.svg create mode 100644 docs/overrides/.icons/material/linked-services.svg create mode 100644 docs/overrides/.icons/material/my-location.svg create mode 100644 docs/overrides/.icons/material/network-node.svg create mode 100644 docs/overrides/.icons/material/sensors.svg create mode 100644 docs/overrides/404.html create mode 100644 docs/overrides/partials/comments.html create mode 100644 docs/references/index.md diff --git a/README.md b/README.md index b5edd7e0..53a3cf72 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@ -# ONVIF Python +# ONVIF Python [![Downloads](https://img.shields.io/pypi/dm/onvif-python?label=Downloads&style=plastic)](https://pepy.tech/projects/onvif-python) [![Python Version](https://img.shields.io/pypi/pyversions/onvif-python?logo=python&logoColor=white&color=blue&style=plastic&label=Python)](https://pypi.org/project/onvif-python) [![PyPI Version](https://img.shields.io/pypi/v/onvif-python?logo=pypi&logoColor=white&color=blue&style=plastic&label=PyPI)](https://pypi.org/project/onvif-python/) [![Quality](https://img.shields.io/codacy/grade/bff08a94e4d447b690cea49c6594826d?style=plastic&logo=codacy&label=Quality)](https://app.codacy.com/gh/nirsimetri/onvif-python/dashboard) [![Coverage](https://img.shields.io/codacy/coverage/bff08a94e4d447b690cea49c6594826d?style=plastic&logo=codacy&label=Coverage)](https://app.codacy.com/gh/nirsimetri/onvif-python/coverage) -[![Downloads](https://img.shields.io/pepy/dt/onvif-python?label=Downloads&color=red&style=plastic)](https://pepy.tech/projects/onvif-python)
[![Build](https://img.shields.io/github/actions/workflow/status/nirsimetri/onvif-python/python-app.yml?logo=github&style=plastic&label=Build)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-app.yml) [![Upload Python](https://img.shields.io/github/actions/workflow/status/nirsimetri/onvif-python/python-publish.yml?logo=github&style=plastic&label=Upload%20Package)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-publish.yml) @@ -18,16 +17,71 @@ Behind the scenes, ONVIF communication relies on **[SOAP](https://en.wikipedia.o This library simplifies that process by wrapping SOAP communication into a clean, Pythonic API. You no longer need to handle low-level XML parsing, namespaces, or security tokens manually; the library takes care of it, letting you focus on building functionality. ## Who Is It For? -- **Individual developers** exploring ONVIF or building hobby projects -- **Companies** building video intelligence, analytics, or VMS platforms -- **Security integrators** who need reliable ONVIF interoperability across devices + +
- - - -
+ + + + + + + + + + + + + + + + +
+  Individual Developers + +  Platform Developers +
+

Explore ONVIF capabilities and build applications for IP cameras and compatible devices.

+ 		+

Build video intelligence, analytics, and video management system (VMS) platforms.

+
+  Security Integrators + +  Device & IoT Engineers +
+

Integrate security devices and troubleshoot ONVIF interoperability across vendors.

+ 		+

Develop, test, and integrate ONVIF-compliant devices and IP-based physical security systems.

+
## Requirements -- **Python**: 3.10 or higher -- **Dependencies**: - - [`zeep>=4.3.0`](https://github.com/mvantellingen/python-zeep) - SOAP client for ONVIF communication - - [`requests>=2.32.0`](https://github.com/psf/requests) - HTTP library for network requests +Python **3.10 or higher** is required. + +## Dependencies + +- [zeep](https://github.com/mvantellingen/python-zeep) → SOAP client for ONVIF communication. +- [requests](https://github.com/psf/requests) → HTTP library for network requests. +- [pyreadline3](https://github.com/pyreadline3/pyreadline3) → Only installed on Windows (`win32`) for CLI auto-completion. ## Installation @@ -36,6 +90,12 @@ From official [PyPI](https://pypi.org/project/onvif-python/): pip install --upgrade onvif-python ``` +Or install using [pipx](https://pipx.pypa.io/stable/) for an isolated environment: +```shell +pipx install git+https://github.com/nirsimetri/onvif-python + +``` + Or clone this repository and install locally: ```shell git clone https://github.com/nirsimetri/onvif-python diff --git a/docs/api/core/index.md b/docs/api/core/index.md new file mode 100644 index 00000000..ea5f2865 --- /dev/null +++ b/docs/api/core/index.md @@ -0,0 +1,22 @@ +--- +hide: + - toc +--- + +# Core API + +
+ +- :material-lan-connect:{ .lg .middle }  [**ONVIFClient**](onvif_client.md) + + --- + + Connect to ONVIF devices, configure connections and authentication, and manage service access. + +- :material-connection:{ .lg .middle }  [**ONVIFOperator**](onvif_operator.md) + + --- + + An **internal class** for coordinating ONVIF operations and managing service interactions. + +
\ No newline at end of file diff --git a/docs/api/core/onvif_client.md b/docs/api/core/onvif_client.md index cfcb26c1..926463f8 100644 --- a/docs/api/core/onvif_client.md +++ b/docs/api/core/onvif_client.md @@ -1,7 +1,15 @@ -# ONVIFClient +--- +comments: true +--- ::: onvif.client.ONVIFClient options: + show_root_heading: true + show_root_full_path: true + docstring_options: + ignore_init_summary: true show_source: true docstring_style: google - members_order: source \ No newline at end of file + members_order: source + heading_level: 2 + merge_init_into_class: true \ No newline at end of file diff --git a/docs/api/core/onvif_discovery.md b/docs/api/core/onvif_discovery.md deleted file mode 100644 index e94dffc2..00000000 --- a/docs/api/core/onvif_discovery.md +++ /dev/null @@ -1,7 +0,0 @@ -# ONVIFDiscovery - -::: onvif.utils.ONVIFDiscovery - options: - show_source: true - docstring_style: google - members_order: source \ No newline at end of file diff --git a/docs/api/core/onvif_operator.md b/docs/api/core/onvif_operator.md index c152f673..ef399f3d 100644 --- a/docs/api/core/onvif_operator.md +++ b/docs/api/core/onvif_operator.md @@ -1,7 +1,12 @@ -# ONVIFOperator +--- +comments: true +--- ::: onvif.operator.ONVIFOperator options: + show_root_heading: true + show_root_full_path: true show_source: true docstring_style: google - members_order: source \ No newline at end of file + members_order: source + heading_level: 2 \ No newline at end of file diff --git a/docs/api/exceptions/index.md b/docs/api/exceptions/index.md new file mode 100644 index 00000000..6e375756 --- /dev/null +++ b/docs/api/exceptions/index.md @@ -0,0 +1,22 @@ +--- +hide: + - toc +--- + +# Exceptions + +
+ +- :material-alert-circle-outline:{ .lg .middle }  [**ONVIFOperationException**](onvif_exception.md) + + --- + + Understand exceptions raised by failed ONVIF operations, including error details for diagnosing issues. + +- :material-reload-alert:{ .lg .middle }  [**Error Handlers**](onvif_error_handlers.md) + + --- + + Explore error-handling utilities for processing and managing errors consistently across ONVIF operations. + +
\ No newline at end of file diff --git a/docs/api/exceptions/onvif_error_handlers.md b/docs/api/exceptions/onvif_error_handlers.md index 818d27e9..d0c3b882 100644 --- a/docs/api/exceptions/onvif_error_handlers.md +++ b/docs/api/exceptions/onvif_error_handlers.md @@ -1,7 +1,12 @@ -# Error Handlers +--- +comments: true +--- ::: onvif.utils.error_handlers options: + show_root_heading: true + show_root_full_path: true show_source: true docstring_style: google - members_order: source \ No newline at end of file + members_order: source + heading_level: 2 \ No newline at end of file diff --git a/docs/api/exceptions/onvif_exception.md b/docs/api/exceptions/onvif_exception.md index 08fa6796..c9e50a2e 100644 --- a/docs/api/exceptions/onvif_exception.md +++ b/docs/api/exceptions/onvif_exception.md @@ -1,7 +1,11 @@ -# ONVIFOperationException +--- +comments: true +--- ::: onvif.utils.ONVIFOperationException options: + show_root_heading: true + show_root_full_path: true show_source: true docstring_style: google members_order: source \ No newline at end of file diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 00000000..c825632e --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,46 @@ +--- +hide: + - toc +--- + +# API Reference + +
+ +- :material-hub-outline:{ .lg .middle }  **Core** + + --- + + Configure ONVIF connections and interact with devices through the main client interfaces. + + --- + [:octicons-arrow-right-24: Explore Core](core/index.md) + +- :material-alert-circle-outline:{ .lg .middle }  **Exceptions** + + --- + + Understand operation exceptions and error-handling utilities for diagnosing and handling failures. + + --- + [:octicons-arrow-right-24: Explore Exceptions](exceptions/index.md) + +- :material-toolbox-outline:{ .lg .middle }  **Utilities** + + --- + + Discover ONVIF devices, configure caching, manage WSDL resources, and extend service behavior. + + --- + [:octicons-arrow-right-24: Explore Utilities](utilities/index.md) + +- :material-linked-services:{ .lg .middle }  **Services** + + --- + + Browse the available ONVIF service clients, from device management, events, PTZ, analytics, and more. + + --- + [:octicons-arrow-right-24: Explore Services](services/index.md) + +
\ No newline at end of file diff --git a/docs/api/services/analytics.md b/docs/api/services/analytics/index.md similarity index 100% rename from docs/api/services/analytics.md rename to docs/api/services/analytics/index.md diff --git a/docs/api/services/ruleengine.md b/docs/api/services/analytics/ruleengine.md similarity index 100% rename from docs/api/services/ruleengine.md rename to docs/api/services/analytics/ruleengine.md diff --git a/docs/api/services/events.md b/docs/api/services/events/index.md similarity index 100% rename from docs/api/services/events.md rename to docs/api/services/events/index.md diff --git a/docs/api/services/notification.md b/docs/api/services/events/notification.md similarity index 100% rename from docs/api/services/notification.md rename to docs/api/services/events/notification.md diff --git a/docs/api/services/pausable_subscription.md b/docs/api/services/events/pausable_subscription.md similarity index 100% rename from docs/api/services/pausable_subscription.md rename to docs/api/services/events/pausable_subscription.md diff --git a/docs/api/services/pullpoint.md b/docs/api/services/events/pullpoint.md similarity index 100% rename from docs/api/services/pullpoint.md rename to docs/api/services/events/pullpoint.md diff --git a/docs/api/services/subscription.md b/docs/api/services/events/subscription.md similarity index 100% rename from docs/api/services/subscription.md rename to docs/api/services/events/subscription.md diff --git a/docs/api/services/index.md b/docs/api/services/index.md new file mode 100644 index 00000000..8ddfa347 --- /dev/null +++ b/docs/api/services/index.md @@ -0,0 +1,158 @@ +--- +hide: + - toc +--- + +# ONVIF Services + +Browse the ONVIF service clients exposed by `onvif-python`. Each service provides access to operations defined by the corresponding ONVIF specifications and supported device capabilities. + +
+ +- :material-devices:{ .lg .middle }  **Device Management** + + --- + + Manage device configuration, device capabilities, interfaces, and related hardware functionality. + + --- + [:octicons-arrow-right-24: Device](device.md) + + [:octicons-arrow-right-24: DeviceIO](deviceio.md) + + [:octicons-arrow-right-24: Display](display.md) + + [:octicons-arrow-right-24: Thermal](thermal.md) + +- :material-sensors:{ .lg .middle }  **Events & Notifications** + + --- + + Subscribe to device events, retrieve notifications, and manage event subscriptions and pull-point mechanisms. + + --- + [:octicons-arrow-right-24: Events](events/index.md) + + [:octicons-arrow-right-24: PullPoint](events/pullpoint.md) + + [:octicons-arrow-right-24: Notification](events/notification.md) + + [:octicons-arrow-right-24: Subscription](events/subscription.md) + + [:octicons-arrow-right-24: PausableSubscription](events/pausable_subscription.md) + + +- :material-video:{ .lg .middle }  **Media & Imaging** + + --- + + Access media profiles, streaming configuration, video sources, imaging settings, and related media operations. + + --- + [:octicons-arrow-right-24: Media](media.md) + + [:octicons-arrow-right-24: Media2](media2.md) + + [:octicons-arrow-right-24: Imaging](imaging.md) + +- :material-pan:{ .lg .middle }  **Device Control** + + --- + + Control device movement (PTZ), focus, presets, and supported movement functions. + + --- + [:octicons-arrow-right-24: PTZ](ptz.md) + + [:octicons-arrow-right-24: Provisioning](provisioning.md) + + +- :material-analytics:{ .lg .middle }  **Analytics** + + --- + + Interact with analytics functionality, rule engines, and analytics-related device services. + + --- + [:octicons-arrow-right-24: Analytics](analytics/index.md) + + [:octicons-arrow-right-24: RuleEngine](analytics/ruleengine.md) + + [:octicons-arrow-right-24: AnalyticsDevice](analyticsdevice.md) + +- :material-filmstrip-box:{ .lg .middle }  **Recording & Playback** + + --- + + Access recording configuration, search for recorded content, replay media, and manage receiver functionality. + + --- + [:octicons-arrow-right-24: Recording](recording.md) + + [:octicons-arrow-right-24: Search](search.md) + + [:octicons-arrow-right-24: Replay](replay.md) + + [:octicons-arrow-right-24: Receiver](receiver.md) + +- :material-automation:{ .lg .middle }  **Automation & Scheduling** + + --- + + Configure device actions and time-based schedules for automated operations. + + --- + [:octicons-arrow-right-24: ActionEngine](actionengine.md) + + [:octicons-arrow-right-24: Schedule](schedule.md) + +- :material-door-closed-lock:{ .lg .middle }  **Access Control** + + --- + + Manage access control systems, door operations, and access rules through ONVIF services. + + --- + [:octicons-arrow-right-24: AccessControl](accesscontrol.md) + + [:octicons-arrow-right-24: DoorControl](doorcontrol.md) + + [:octicons-arrow-right-24: AccessRules](accessrules.md) + + [:octicons-arrow-right-24: AuthenticationBehavior](authenticationbehavior.md) + + [:octicons-arrow-right-24: Credential](credential.md) + +- :material-security:{ .lg .middle }  **Security** + + --- + + Explore ONVIF security services for authentication, authorization, network authentication, cryptographic key management, and media integrity. + + --- + [:octicons-arrow-right-24: AdvancedSecurity](security/index.md) + + [:octicons-arrow-right-24: AuthorizationServer](security/authorizationserver.md) + + [:octicons-arrow-right-24: Dot1x](security/dot1x.md) + + [:octicons-arrow-right-24: JWT](security/jwt.md) + + [:octicons-arrow-right-24: Keystore](security/keystore.md) + + [:octicons-arrow-right-24: MediaSigning](security/mediasigning.md) + + [:octicons-arrow-right-24: TLSServer](security/tlsserver.md) + +- :material-lan:{ .lg .middle }  **Connectivity & Applications** + + --- + + Manage device applications and establish connectivity between services behind firewalls and internet-accessible clients. + + --- + [:octicons-arrow-right-24: AppManagement](appmgmt.md) + + [:octicons-arrow-right-24: Uplink](uplink.md) + +
\ No newline at end of file diff --git a/docs/api/services/authorizationserver.md b/docs/api/services/security/authorizationserver.md similarity index 100% rename from docs/api/services/authorizationserver.md rename to docs/api/services/security/authorizationserver.md diff --git a/docs/api/services/dot1x.md b/docs/api/services/security/dot1x.md similarity index 100% rename from docs/api/services/dot1x.md rename to docs/api/services/security/dot1x.md diff --git a/docs/api/services/advancedsecurity.md b/docs/api/services/security/index.md similarity index 100% rename from docs/api/services/advancedsecurity.md rename to docs/api/services/security/index.md diff --git a/docs/api/services/jwt.md b/docs/api/services/security/jwt.md similarity index 100% rename from docs/api/services/jwt.md rename to docs/api/services/security/jwt.md diff --git a/docs/api/services/keystore.md b/docs/api/services/security/keystore.md similarity index 90% rename from docs/api/services/keystore.md rename to docs/api/services/security/keystore.md index a39bc26d..66170745 100644 --- a/docs/api/services/keystore.md +++ b/docs/api/services/security/keystore.md @@ -1,4 +1,4 @@ -# KeyStore +# Keystore ::: onvif.services.security.keystore options: diff --git a/docs/api/services/mediasigning.md b/docs/api/services/security/mediasigning.md similarity index 100% rename from docs/api/services/mediasigning.md rename to docs/api/services/security/mediasigning.md diff --git a/docs/api/services/tlsserver.md b/docs/api/services/security/tlsserver.md similarity index 100% rename from docs/api/services/tlsserver.md rename to docs/api/services/security/tlsserver.md diff --git a/docs/api/utilities/cache_mode.md b/docs/api/utilities/cache_mode.md index 6f791683..530a9154 100644 --- a/docs/api/utilities/cache_mode.md +++ b/docs/api/utilities/cache_mode.md @@ -1,8 +1,13 @@ -# CacheMode +--- +comments: true +--- ::: onvif.operator.CacheMode options: + show_root_heading: true + show_root_full_path: true show_source: true docstring_style: google members: true - members_order: source \ No newline at end of file + members_order: source + heading_level: 2 \ No newline at end of file diff --git a/docs/api/utilities/index.md b/docs/api/utilities/index.md new file mode 100644 index 00000000..3f427aec --- /dev/null +++ b/docs/api/utilities/index.md @@ -0,0 +1,46 @@ +--- +hide: + - toc +--- + +# Utilities + +
+ +- :material-radar:{ .lg .middle }  [**ONVIFDiscovery**](onvif_discovery.md) + + --- + + Discover ONVIF-compliant devices on the local network using WS-Discovery multicast. + +- :material-database-cog-outline:{ .lg .middle }  [**CacheMode**](cache_mode.md) + + --- + + Configure the caching strategy used by the library to balance performance and resource usage. + +- :material-file-cog-outline:{ .lg .middle }  [**ONVIFWSDL**](onvif_wsdl.md) + + --- + + Work with WSDL resources used to describe ONVIF service operations and their SOAP interfaces. + +- :material-network-node:{ .lg .middle }  [**ONVIFService**](onvif_service.md) + + --- + + Provides shared functionality for ONVIF service clients and common service operations. + +- :material-xml:{ .lg .middle }  [**ZeepPatcher**](zeep_patcher.md) + + --- + + Apply compatibility enhancements to Zeep SOAP processing for ONVIF-specific behavior. + +- :material-puzzle-outline:{ .lg .middle }  [**Plugins**](plugins.md) + + --- + + Explore plugin-related functionality for extending or customizing supported library behavior. + +
\ No newline at end of file diff --git a/docs/api/utilities/onvif_discovery.md b/docs/api/utilities/onvif_discovery.md new file mode 100644 index 00000000..113f2d58 --- /dev/null +++ b/docs/api/utilities/onvif_discovery.md @@ -0,0 +1,15 @@ +--- +comments: true +--- + +::: onvif.utils.ONVIFDiscovery + options: + docstring_options: + ignore_init_summary: true + show_source: true + show_root_heading: true + show_root_full_path: true + docstring_style: google + members_order: source + heading_level: 2 + merge_init_into_class: true \ No newline at end of file diff --git a/docs/api/utilities/onvif_service.md b/docs/api/utilities/onvif_service.md index 74ebb3fb..2eb1ea56 100644 --- a/docs/api/utilities/onvif_service.md +++ b/docs/api/utilities/onvif_service.md @@ -1,7 +1,12 @@ -# ONVIFService +--- +comments: true +--- ::: onvif.utils.ONVIFService options: + show_root_heading: true + show_root_full_path: true show_source: true docstring_style: google - members_order: source \ No newline at end of file + members_order: source + heading_level: 2 \ No newline at end of file diff --git a/docs/api/utilities/onvif_wsdl.md b/docs/api/utilities/onvif_wsdl.md index 5ece281c..c0ca6389 100644 --- a/docs/api/utilities/onvif_wsdl.md +++ b/docs/api/utilities/onvif_wsdl.md @@ -1,7 +1,12 @@ -# ONVIFWSDL +--- +comments: true +--- ::: onvif.utils.ONVIFWSDL options: + show_root_heading: true + show_root_full_path: true show_source: true docstring_style: google - members_order: source \ No newline at end of file + members_order: source + heading_level: 2 \ No newline at end of file diff --git a/docs/api/utilities/plugins.md b/docs/api/utilities/plugins.md index 00fe09fe..fb6338a9 100644 --- a/docs/api/utilities/plugins.md +++ b/docs/api/utilities/plugins.md @@ -1,7 +1,15 @@ -# Plugins +--- +comments: true +--- ::: onvif.utils.plugins options: + docstring_options: + ignore_init_summary: true + show_root_heading: true + show_root_full_path: true show_source: true docstring_style: google - members_order: source \ No newline at end of file + members_order: source + merge_init_into_class: true + heading_level: 1 \ No newline at end of file diff --git a/docs/api/utilities/zeep_patcher.md b/docs/api/utilities/zeep_patcher.md index fec06266..2a0c8464 100644 --- a/docs/api/utilities/zeep_patcher.md +++ b/docs/api/utilities/zeep_patcher.md @@ -1,7 +1,12 @@ -# ZeepPatcher +--- +comments: true +--- ::: onvif.utils.ZeepPatcher options: + show_root_heading: true + show_root_full_path: true show_source: true docstring_style: google - members_order: source \ No newline at end of file + members_order: source + heading_level: 2 \ No newline at end of file diff --git a/docs/philosophy.md b/docs/approach.md similarity index 95% rename from docs/philosophy.md rename to docs/approach.md index 8074fa16..1d5cb364 100644 --- a/docs/philosophy.md +++ b/docs/approach.md @@ -1,7 +1,13 @@ +--- +hide: + - path +comments: true +--- + !!! info This library will be continuously updated as ONVIF versions are updated. It uses a built-in WSDL that will always follow changes to the [ONVIF WSDL Specifications](https://github.com/onvif/specs). - You can also use your own ONVIF WSDL file by adding the `wsdl_dir` argument; see [`ONVIFClient`](core/onvif_client.md). + You can also use your own ONVIF WSDL file by adding the `wsdl_dir` argument; see [`ONVIFClient`](main/onvif_client.md). ### WYSIWYG (What You See is What You Get) Every ONVIF operation in the library mirrors the official ONVIF specification exactly. Method names, parameter structures, and response formats follow ONVIF standards without abstraction layers or renamed interfaces. What you see in the ONVIF documentation is exactly what you get in Python. diff --git a/docs/core/onvif_discovery.md b/docs/core/onvif_discovery.md deleted file mode 100644 index eeefc2ae..00000000 --- a/docs/core/onvif_discovery.md +++ /dev/null @@ -1 +0,0 @@ -To be written.. see [`ONVIFDiscovery`](../api/core/onvif_discovery.md) \ No newline at end of file diff --git a/docs/hooks/griffe_extensions.py b/docs/hooks/griffe_extensions.py new file mode 100644 index 00000000..bc411648 --- /dev/null +++ b/docs/hooks/griffe_extensions.py @@ -0,0 +1,35 @@ +"""Griffe extensions.""" + +from __future__ import annotations + +import importlib.util +from pathlib import Path + +import griffe + +_SHORTCODES_PATH = Path(__file__).with_name("shortcodes.py") +_SPEC = importlib.util.spec_from_file_location( + "onvif_doc_shortcodes", + _SHORTCODES_PATH, +) + +if _SPEC is None or _SPEC.loader is None: + raise ImportError(f"Cannot load shortcode module: {_SHORTCODES_PATH}") + +_SHORTCODES = importlib.util.module_from_spec(_SPEC) +_SPEC.loader.exec_module(_SHORTCODES) + +replace_docstring_shortcodes = _SHORTCODES.replace_docstring_shortcodes + + +class DocstringShortcodes(griffe.Extension): + """Process supported Markdown shortcodes in Python docstrings.""" + + def on_object(self, *, obj: griffe.Object, **kwargs) -> None: + """Replace shortcodes in an object's docstring.""" + docstring = obj.docstring + + if docstring is None: + return + + docstring.value = replace_docstring_shortcodes(docstring.value) diff --git a/docs/hooks.py b/docs/hooks/misc.py similarity index 64% rename from docs/hooks.py rename to docs/hooks/misc.py index 615df332..24def5ff 100644 --- a/docs/hooks.py +++ b/docs/hooks/misc.py @@ -1,6 +1,9 @@ -def on_page_content(html, page, config, files): +"""Misc Mkdocs hooks.""" + + +def on_page_content(html, page, config, files): # pylint: disable=unused-argument """Exclude mkdocstrings source blocks from Material search.""" return html.replace( '
', '
', - ) \ No newline at end of file + ) diff --git a/docs/hooks/shortcodes.py b/docs/hooks/shortcodes.py new file mode 100644 index 00000000..2c78b421 --- /dev/null +++ b/docs/hooks/shortcodes.py @@ -0,0 +1,408 @@ +"""Shortcodes hook. + +Origin source: +https://github.com/squidfunk/mkdocs-material/blob/master/src/overrides/hooks/shortcodes.py +""" + +# Copyright (c) 2016-2025 Martin Donath + +# Modified by Nirsimetri Technologies® for ONVIF Python documentation. + +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: + +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. + +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. + +# pylint: disable=unused-argument,redefined-builtin +# pylint: disable=unnecessary-lambda,too-many-branches +# pylint: disable=too-many-return-statements +from __future__ import annotations + +import posixpath +import re +from re import Match + +from mkdocs.config.defaults import MkDocsConfig +from mkdocs.structure.files import File, Files +from mkdocs.structure.pages import Page + +# ----------------------------------------------------------------------------- +# Constants +# ----------------------------------------------------------------------------- + +REPOSITORY = "https://github.com/nirsimetri/onvif-python" +RELEASE_ENDPOINT = "onvif-python/releases" +EXAMPLE_PATH = "blob/main/examples" +MODULE_PATH = "blob/main/onvif" + +ICON_FOR_VERSION = "material-source-pull" +ICON_FOR_ONVIF_VERSION = "material-app-badging" +ICON_FOR_INTERNAL = "material-lock-outline" +ICON_FOR_EXCEPTION = "material-alert-circle-outline" +ICON_FOR_ERROR_HANDLER = "material-reload-alert" +ICON_FOR_SERVICE_ENTRY_POINT = "material-my-location" +ICON_FOR_FEATURE = "material-toggle-switch" +ICON_FOR_PLUGIN = "material-puzzle-outline" +ICON_FOR_UTILITY = "material-hammer-wrench" +ICON_FOR_EXAMPLE_VIEW = "material-file-eye" +ICON_FOR_EXAMPLE_FILE = "material-file-code" +ICON_FOR_MODULE = "material-code-block-tags" +ICON_FOR_DEMO = "material-github" +ICON_FOR_DEFAULT_VALUE = "material-water" +ICON_FOR_DEFAULT_NONE = "material-water-outline" +ICON_FOR_DEFAULT_COMPUTED = "material-water-check" +ICON_FOR_METADATA = "material-list-box-outline" +ICON_FOR_REQUIRED = "material-alert" +ICON_FOR_EXPERIMENTAL = "material-flask-outline" + +# ----------------------------------------------------------------------------- +# For griffe +# ----------------------------------------------------------------------------- + + +def replace_docstring_shortcodes(docstring: str) -> str: + """Replace supported shortcodes in Python docstrings.""" + return re.sub( + r"", + lambda match: replace(match), + docstring, + flags=re.I | re.M, + ) + + +# ----------------------------------------------------------------------------- +# Hooks +# ----------------------------------------------------------------------------- + + +def on_page_markdown( + markdown: str, + *, + page: Page, + config: MkDocsConfig, + files: Files, +): + """Replace supported shortcodes in page Markdown.""" + return re.sub( + r"", + lambda match: replace(match, page, files), + markdown, + flags=re.I | re.M, + ) + + +# ----------------------------------------------------------------------------- +# Helper functions +# ----------------------------------------------------------------------------- + + +def replace(match: Match, page: Page | None = None, files: Files | None = None): + """Shortcodes replacer.""" + + type, args = match.groups() + args = args.strip() + + match type: + case "version": + return _badge_for_version(args, page, files) + case "onvif_version": + return _badge_for_onvif_version(args) + case "flag": + return flag(args, page, files) + case "option": + return option(args) + case "setting": + return setting(args) + case "internal": + return _badge_for_internal(args, page, files) + case "exception": + return _badge_for_exception(args, page, files) + case "error_handler": + return _badge_for_error_handler(args, page, files) + case "entry_point": + return _badge_for_entry_point(args, page, files) + case "feature": + return _badge_for_feature(args, page, files) + case "plugin": + return _badge_for_plugin(args, page, files) + case "utility": + return _badge_for_utility(args, page, files) + case "example": + return _badge_for_example(args, page, files) + case "example_view": + return _badge_for_example_view(args, page, files) + case "example_file": + return _badge_for_example_file(args, page, files) + case "module": + return _badge_for_module(args, page, files) + case "demo": + return _badge_for_demo(args, page, files) + case "default": + if args == "none": + return _badge_for_default_none(page, files) + if args == "computed": + return _badge_for_default_computed(page, files) + return _badge_for_default(args, page, files) + case _: + raise RuntimeError(f"Unknown shortcode: {type}") + + +def flag(args: str, page: Page, files: Files): + """Create a flag of a specific type.""" + type, *_ = args.split(" ", 1) + + match type: + case "experimental": + return _badge_for_experimental(page, files) + case "required": + return _badge_for_required(page, files) + case "metadata": + return _badge_for_metadata(page, files) + case _: + raise RuntimeError(f"Unknown type: {type}") + + +def option(type: str): + """Create a linkable option.""" + _, *_, name = re.split(r"[.:]", type) + return f"[`{name}`](#+{type}){{ #+{type} }}\n\n" + + +def setting(type: str): + """Create a linkable setting - @todo append them to the bottom of the page.""" + _, *_, name = re.split(r"[.*]", type) + return f"`{name}` {{ #{type} }}\n\n[{type}]: #{type}\n\n" + + +# ----------------------------------------------------------------------------- + + +def _resolve_path(path: str, page: Page, files: Files): + """Resolve path of file relative to given page - the posixpath always includes + one additional level of `..` which we need to remove.""" + path, anchor, *_ = f"{path}#".split("#") + path = _resolve(files.get_file_from_path(path), page) + return "#".join([path, anchor]) if anchor else path + + +def _resolve(file: File, page: Page): + """Resolve path of file relative to given page - the posixpath always includes + one additional level of `..` which we need to remove.""" + path = posixpath.relpath(file.src_uri, page.file.src_uri) + return posixpath.sep.join(path.split(posixpath.sep)[1:]) + + +# ----------------------------------------------------------------------------- + + +# Create badge +def _badge(icon: str, text: str = "", type: str = "", title: str = ""): + classes = f"mdx-badge mdx-badge--{type}" if type else "mdx-badge" + + return "".join( + [ + f'', + *( + [f'{icon}'] + if icon + else [] + ), + *([f'{text}'] if text else []), + "", + ] + ) + + +# Create badge for package version +def _badge_for_version(text: str, page: Page | None = None, files: Files | None = None): + path = f"releases.md#v{text}" + + if page is not None and files is not None: + href = _resolve_path(path, page, files) + else: + href = f"/{RELEASE_ENDPOINT}/#v{text}" + + return _badge( + icon=f":{ICON_FOR_VERSION}:", + text=f"[`v{text}`]({href})" if text else "", + title="Minimum package version", + ) + + +# Create badge for ONVIF version +def _badge_for_onvif_version(args: str): + """Create a badge linking an ONVIF version to its specification.""" + match = re.fullmatch(r"(\S+)\s+(https?://\S+)", args.strip()) + + if not match: + raise ValueError("Invalid onvif_version shortcode. Expected: VERSION URL") + + version, href = match.groups() + + return _badge( + icon=f":{ICON_FOR_ONVIF_VERSION}:", + text=f"[`{version}`]({href}){{.no-external-icon }}", + title="Minimum ONVIF version", + ) + + +# Create badge for internal +def _badge_for_internal(text: str, page: Page, files: Files): + return _badge( + icon=f":{ICON_FOR_INTERNAL}:", + title=text or "Internal implementation", + text=f"*{text}*" if text else "", + ) + + +# Create badge for exception +def _badge_for_exception(text: str, page: Page, files: Files): + return _badge( + icon=f":{ICON_FOR_EXCEPTION}:", + title=text or "Exception type", + text=f"*{text}*" if text else "", + ) + + +# Create badge for error handler +def _badge_for_error_handler(text: str, page: Page, files: Files): + return _badge( + icon=f":{ICON_FOR_ERROR_HANDLER}:", + title=text or "Error handler", + text=f"*{text}*" if text else "", + ) + + +# Create badge for entry point +def _badge_for_entry_point(text: str, page: Page, files: Files): + return _badge( + icon=f":{ICON_FOR_SERVICE_ENTRY_POINT}:", + title=text or "ONVIF Service entry point", + text=f"*{text}*" if text else "", + ) + + +# Create badge for feature +def _badge_for_feature(text: str, page: Page, files: Files): + return _badge( + icon=f":{ICON_FOR_FEATURE}:", + title=text or "Optional feature", + text=f"*{text}*" if text else "", + ) + + +# Create badge for plugin +def _badge_for_plugin(text: str, page: Page, files: Files): + return _badge( + icon=f":{ICON_FOR_PLUGIN}:", + title=text or "Plugin", + text=f"*{text}*" if text else "", + ) + + +# Create badge for utility +def _badge_for_utility(text: str, page: Page, files: Files): + return _badge( + icon=f":{ICON_FOR_UTILITY}:", + title=text or "Utility", + text=f"*{text}*" if text else "", + ) + + +# Create badge for example +def _badge_for_example(text: str, page: Page, files: Files): + return "\n".join( + [ + _badge_for_example_file(text, page, files), + _badge_for_example_view(text, page, files), + ] + ) + + +# Create badge for example view +def _badge_for_example_view(text: str, page: Page, files: Files): + href = f"{REPOSITORY}/{EXAMPLE_PATH}/{text}" + return _badge( + icon=f"[:{ICON_FOR_EXAMPLE_VIEW}:]({href}){{.no-external-icon }}", + title=f"View example `{text}`", + type="right", + ) + + +# Create badge for example download +def _badge_for_example_file(text: str, page: Page, files: Files): + href = f"{REPOSITORY}/{EXAMPLE_PATH}/{text}" + return _badge( + icon=f"[:{ICON_FOR_EXAMPLE_FILE}:]({href}){{.no-external-icon }}", + title="Inspect example file", + text=f"[`{text}`]({href})", + type="right", + ) + + +# Create badge for module +def _badge_for_module(text: str, page: Page, files: Files): + href = f"{REPOSITORY}/{MODULE_PATH}/{text}" + return _badge( + icon=f"[:{ICON_FOR_MODULE}:]({href}){{.no-external-icon }}", + title=f"Inspect module `{text}`", + type="right", + ) + + +# Create badge for demo repository +def _badge_for_demo(text: str, page: Page, files: Files): + href = text + return _badge( + icon=f"[:{ICON_FOR_DEMO}:]({href})", + title="Go to repository", + text=f"*{text}*" if text else "", + type="right", + ) + + +# Create badge for default value +def _badge_for_default(text: str, page: Page, files: Files): + return _badge( + icon=f":{ICON_FOR_DEFAULT_VALUE}:", title=text or "Default value", text=text + ) + + +# Create badge for empty default value +def _badge_for_default_none(page: Page, files: Files): + return _badge(icon=f":{ICON_FOR_DEFAULT_NONE}:", title="Default value is empty") + + +# Create badge for computed default value +def _badge_for_default_computed(page: Page, files: Files): + return _badge( + icon=f":{ICON_FOR_DEFAULT_COMPUTED}:", title="Default value is computed" + ) + + +# Create badge for metadata property flag +def _badge_for_metadata(page: Page, files: Files): + return _badge(icon=f":{ICON_FOR_METADATA}:", title="Metadata property") + + +# Create badge for required value flag +def _badge_for_required(page: Page, files: Files): + return _badge(icon=f":{ICON_FOR_REQUIRED}:", title="Required value") + + +# Create badge for experimental flag +def _badge_for_experimental(page: Page, files: Files): + return _badge(icon=f":{ICON_FOR_EXPERIMENTAL}:", title="Experimental") diff --git a/docs/index.md b/docs/index.md index 424bed7d..1701b984 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,15 @@ -# ONVIF Python +--- +hide: + - navigation +--- + +# ONVIF Python  [![Downloads](https://img.shields.io/pypi/dm/onvif-python?label=Downloads&style=plastic)](https://pepy.tech/projects/onvif-python){ .no-external-icon } + [![Python Version](https://img.shields.io/pypi/pyversions/onvif-python?logo=python&logoColor=white&color=blue&style=plastic&label=Python)](https://pypi.org/project/onvif-python){ .no-external-icon } [![PyPI Version](https://img.shields.io/pypi/v/onvif-python?logo=pypi&logoColor=white&color=blue&style=plastic&label=PyPI)](https://pypi.org/project/onvif-python/){ .no-external-icon } [![Quality](https://img.shields.io/codacy/grade/bff08a94e4d447b690cea49c6594826d?style=plastic&logo=codacy&label=Quality)](https://app.codacy.com/gh/nirsimetri/onvif-python/dashboard){ .no-external-icon } [![Coverage](https://img.shields.io/codacy/coverage/bff08a94e4d447b690cea49c6594826d?style=plastic&logo=codacy&label=Coverage)](https://app.codacy.com/gh/nirsimetri/onvif-python/coverage){ .no-external-icon } -[![Downloads](https://img.shields.io/pepy/dt/onvif-python?label=Downloads&color=red&style=plastic)](https://pepy.tech/projects/onvif-python){ .no-external-icon }
[![Build](https://img.shields.io/github/actions/workflow/status/nirsimetri/onvif-python/python-app.yml?logo=github&style=plastic&label=Build)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-app.yml){ .no-external-icon } [![Upload Python](https://img.shields.io/github/actions/workflow/status/nirsimetri/onvif-python/python-publish.yml?logo=github&style=plastic&label=Upload%20Package)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-publish.yml){ .no-external-icon } @@ -18,13 +23,73 @@ Behind the scenes, ONVIF communication relies on **[SOAP](https://en.wikipedia.o This library simplifies that process by wrapping SOAP communication into a clean, Pythonic API. You no longer need to handle low-level XML parsing, namespaces, or security tokens manually; the library takes care of it, letting you focus on building functionality. ## Who Is It For? -- **Individual developers** exploring ONVIF or building hobby projects -- **Companies** building video intelligence, analytics, or VMS platforms -- **Security integrators** who need reliable ONVIF interoperability across devices -## Requirements +
+ +- :material-account-hard-hat:{ .lg .middle }  **Individual Developers** + + --- + + Explore ONVIF capabilities and build applications for IP cameras and compatible devices. + +- :material-video-wireless:{ .lg .middle }  **Platform Developers** + + --- + + Build video intelligence, analytics, and video management system (VMS) platforms. + +- :material-cctv:{ .lg .middle }  **Security Integrators** + + --- + + Integrate security devices and troubleshoot ONVIF interoperability across vendors. + +- :material-chip:{ .lg .middle }  **Device & IoT Engineers** + + --- + + Develop, test, and integrate ONVIF-compliant devices and IP-based physical security systems. + +
+ +## Dependencies + +
+ +- :material-language-python:{ .lg .middle }  **Python** + + --- + + Python **3.10 or higher** is required. + + --- + [:octicons-arrow-right-24: PyPI](https://pypi.org/project/onvif-python){ .no-external-icon } + +- :material-package-variant-closed:{ .lg .middle }  **Zeep** + + --- + + SOAP client for ONVIF communication. + + --- + [:octicons-arrow-right-24: GitHub](https://github.com/mvantellingen/python-zeep){ .no-external-icon } + +- :material-package-variant-closed:{ .lg .middle }  **Requests** + + --- + + HTTP library for network requests. + + --- + [:octicons-arrow-right-24: GitHub](https://github.com/psf/requests){ .no-external-icon } + +- :material-package-variant-closed:{ .lg .middle }  **Pyreadline3** + + --- + + Only installed on Windows (`win32`). + + --- + [:octicons-arrow-right-24: GitHub](https://github.com/pyreadline3/pyreadline3){ .no-external-icon } -- **Python**: 3.10 or higher -- **Dependencies**: - - [`zeep>=4.3.0`](https://github.com/mvantellingen/python-zeep) - SOAP client for ONVIF communication - - [`requests>=2.32.0`](https://github.com/psf/requests) - HTTP library for network requests +
diff --git a/docs/installation.md b/docs/installation.md index 3ac6ba09..57c63a5c 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,6 +1,18 @@ +--- +hide: + - path +--- + From official [PyPI](https://pypi.org/project/onvif-python/): ```console pip install --upgrade onvif-python + +``` + +Or install using [pipx](https://pipx.pypa.io/stable/) for an isolated environment: +```console +pipx install git+https://github.com/nirsimetri/onvif-python + ``` Or clone this repository and install locally: @@ -10,7 +22,7 @@ cd onvif-python pip install . ``` -Once the installation is successful, you can also immediately access the [ONVIF CLI](core/onvif_cli.md) via the terminal using: +Once the installation is successful, you can also immediately access the [ONVIF CLI](main/onvif_cli.md) via the terminal using: ```console onvif --help ``` \ No newline at end of file diff --git a/docs/javascripts/external-links.js b/docs/javascripts/external-links.js index 114b96fa..dd6a699e 100644 --- a/docs/javascripts/external-links.js +++ b/docs/javascripts/external-links.js @@ -4,29 +4,63 @@ document$.subscribe(() => { document.querySelectorAll('.md-content a[href]').forEach((link) => { const url = new URL(link.href, window.location.href); + const isEditButton = + link.classList.contains('md-content__button') && + url.hostname === 'github.com' && + /\/edit\//.test(url.pathname); + + const isViewButton = + link.classList.contains('md-content__button') && + url.hostname === 'github.com' && + /\/raw\//.test(url.pathname); + + if (isEditButton || isViewButton) { + link.target = '_blank'; + link.rel = 'noopener noreferrer'; + + link.dataset.tooltip = isEditButton + ? 'Edit this page' + : 'View source of this page'; + + // Remove external icons from Edit and View buttons. + link.querySelectorAll('.external-link-icon').forEach((icon) => { + icon.remove(); + }); + + return; + } + if ( - (url.protocol === "http:" || url.protocol === "https:") && + ['http:', 'https:'].includes(url.protocol) && url.hostname !== window.location.hostname ) { - link.target = "_blank"; - link.rel = "noopener noreferrer"; + link.target = '_blank'; + link.rel = 'noopener noreferrer'; + + // Do not add external icons inside source-code blocks. + if (link.closest('.highlight, .highlighttable, pre')) { + return; + } if ( - !link.classList.contains("no-external-icon") && - !link.querySelector(".external-link-icon") + !link.classList.contains('no-external-icon') && + !link.querySelector('.external-link-icon') ) { - const icon = document.createElement("span"); - icon.className = "external-link-icon"; - icon.setAttribute("aria-hidden", "true"); + const icon = document.createElement('span'); + icon.className = 'external-link-icon'; + icon.setAttribute('aria-hidden', 'true'); icon.innerHTML = ` - - + + `; - link.appendChild(icon); + const code = link.querySelector('code'); + + // Place the icon inside inline code when present. + (code || link).appendChild(icon); } } }); -}); \ No newline at end of file +}); diff --git a/docs/javascripts/extra.js b/docs/javascripts/extra.js new file mode 100644 index 00000000..6c1d1713 --- /dev/null +++ b/docs/javascripts/extra.js @@ -0,0 +1,34 @@ +/* global document$, GITHUB_REPOSITORY */ + +document$.subscribe(() => { + document.querySelectorAll('.md-content__button[href*="/raw/"]').forEach((editButton) => { + if (editButton.parentElement.querySelector(".report-issue-button")) return; + + const issueTitle = + document.querySelector(".md-content h1")?.textContent.trim() || + document.title; + const issueBody = encodeURIComponent( + `**Reference:** \n${window.location.href}\n\n**Description:**\n` + ); + + const reportButton = document.createElement("a"); + reportButton.className = "md-content__button md-icon report-issue-button"; + reportButton.href = + `https://github.com/${GITHUB_REPOSITORY}/issues/new` + + `?title=${issueTitle}&body=${issueBody}`; + reportButton.target = "_blank"; + reportButton.rel = "noopener noreferrer"; + reportButton.dataset.tooltip = "Report an issue"; + reportButton.setAttribute("aria-label", "Report an issue"); + reportButton.innerHTML = ` + + `; + + editButton.after(reportButton); + }); +}); \ No newline at end of file diff --git a/docs/javascripts/github-releases.js b/docs/javascripts/github-releases.js index b1acc630..7db63253 100644 --- a/docs/javascripts/github-releases.js +++ b/docs/javascripts/github-releases.js @@ -1,4 +1,4 @@ - /* global DOMPurify, marked, document$ */ + /* global DOMPurify, marked, document$, GITHUB_REPOSITORY */ const GITHUB_REPOSITORY = "nirsimetri/onvif-python"; const [, GITHUB_REPOSITORY_NAME] = GITHUB_REPOSITORY.split("/"); diff --git a/docs/javascripts/section-flash.js b/docs/javascripts/section-flash.js new file mode 100644 index 00000000..4e109581 --- /dev/null +++ b/docs/javascripts/section-flash.js @@ -0,0 +1,112 @@ +/* global document$ */ + +let scrollFallback; + +document$.subscribe(() => { + const previousOverlay = document.querySelector( + '.section-flash-overlay', + ); + + if (previousOverlay) { + previousOverlay.classList.remove('is-visible'); + previousOverlay.removeAttribute('style'); + } + const content = document.querySelector('.md-content__inner'); + + if (!content) { + return; + } + + let outline = document.querySelector('.section-flash-overlay'); + + if (!outline) { + outline = document.createElement('div'); + outline.className = 'section-flash-overlay'; + document.body.appendChild(outline); + } + + document.querySelectorAll('.md-nav--secondary a[href*="#"]').forEach((link) => { + link.addEventListener('click', () => { + const url = new URL(link.href, window.location.href); + + if (url.pathname !== window.location.pathname || !url.hash) { + return; + } + + const heading = document.getElementById( + decodeURIComponent(url.hash.slice(1)), + ); + + if (!heading || !content.contains(heading)) { + return; + } + + const level = Number(heading.tagName.slice(1)); + + if (!Number.isInteger(level) || level < 1 || level > 6) { + return; + } + + const section = [heading]; + let sibling = heading.nextElementSibling; + + while (sibling) { + if ( + sibling.matches('.md-source-file, .md-content__button, .footnote') || + (/^H[1-6]$/.test(sibling.tagName) && + Number(sibling.tagName.slice(1)) <= level) + ) { + break; + } + + section.push(sibling); + sibling = sibling.nextElementSibling; + } + + const paddingYtop = 3; + const paddingYbottom = 5; + const paddingX = 10; + + const flash = () => { + const start = section[0].getBoundingClientRect(); + const end = section[section.length - 1].getBoundingClientRect(); + + outline.style.top = `${start.top - paddingYtop}px`; + outline.style.left = `${start.left - paddingX}px`; + outline.style.width = `${start.width + paddingX * 2}px`; + outline.style.height = `${end.bottom - start.top + paddingYbottom * 2}px`; + + outline.classList.remove('is-visible'); + void outline.offsetWidth; + outline.classList.add('is-visible'); + }; + + clearTimeout(scrollFallback); + window.removeEventListener('scrollend', onScrollEnd); + + let flashed = false; + + function finishScroll() { + if (flashed) { + return; + } + + flashed = true; + clearTimeout(scrollFallback); + window.removeEventListener('scrollend', onScrollEnd); + flash(); + } + + function onScrollEnd() { + finishScroll(); + } + + if ('onscrollend' in window) { + window.addEventListener('scrollend', onScrollEnd); + scrollFallback = setTimeout(finishScroll, 1500); + } else { + scrollFallback = setTimeout(finishScroll, 700); + } + }); + }); +}); \ No newline at end of file diff --git a/docs/legal/license.md b/docs/legal/license.md index 11a8ebbf..34a36ed0 100644 --- a/docs/legal/license.md +++ b/docs/legal/license.md @@ -1,3 +1,8 @@ +--- +hide: + - path +--- + MIT License Copyright (c) 2025-2026 Nirsimetri Technologies® diff --git a/docs/legal/legal_notice.md b/docs/legal/notice.md similarity index 98% rename from docs/legal/legal_notice.md rename to docs/legal/notice.md index 6de503db..293b51d7 100644 --- a/docs/legal/legal_notice.md +++ b/docs/legal/notice.md @@ -1,3 +1,8 @@ +--- +hide: + - path +--- + This project is an **independent open-source implementation** of the [ONVIF](https://www.onvif.org) specifications. It is **not affiliated with, endorsed by, or sponsored by ONVIF** or its member companies. - The name **“ONVIF”** and the ONVIF logo are registered trademarks of the ONVIF organization. diff --git a/docs/llms.txt b/docs/llms.txt new file mode 100644 index 00000000..e31bf166 --- /dev/null +++ b/docs/llms.txt @@ -0,0 +1,220 @@ +# ONVIF Python + +> A modern, developer-friendly Python library for discovering, connecting to, and managing ONVIF-compliant IP cameras, NVRs, and other ONVIF-compliant devices. It provides a Pythonic interface to ONVIF SOAP services, built-in WSDL definitions, WS-Discovery, device management, media streaming, PTZ, events, analytics, and a feature-rich command-line interface. + +ONVIF Python is an independent open-source implementation of the ONVIF specifications, maintained by Nirsimetri Technologies. It is designed for individual developers, companies building video management systems (VMS) and video intelligence platforms, security integrators, and IoT developers. + +The library uses Zeep for SOAP communication and Requests for HTTP transport. It aims to preserve official ONVIF operation names, parameter structures, and response formats while providing type hints, IDE completion, connection configuration, caching, error handling, and debugging facilities. + +- Official documentation: https://nirsimetri.github.io/onvif-python +- GitHub repository: https://github.com/nirsimetri/onvif-python +- PyPI package: https://pypi.org/project/onvif-python +- Python requirement: 3.10 or higher +- License: MIT; see the repository's license and notice for applicable terms. + +## Getting Started + +- [Installation](https://nirsimetri.github.io/onvif-python/installation/): Install the package using pip, pipx, or a local repository checkout. +- [Quickstart](https://nirsimetri.github.io/onvif-python/quick_start/): Discover ONVIF devices, initialize `ONVIFClient`, create service instances, retrieve device information, and obtain RTSP stream URIs. +- [Philosophy](https://nirsimetri.github.io/onvif-python/philosophy/): Understand the library's design principles, WYSIWYG API approach, interoperability goals, specification accuracy, Python typing, and dependency philosophy. + +## Main Features + +- [ONVIF Client Guide](https://nirsimetri.github.io/onvif-python/main/onvif_client/): Configure connections, authentication, HTTPS, timeouts, WSDL directories, Zeep plugins, caching modes, and XML debugging. +- [CLI Guide](https://nirsimetri.github.io/onvif-python/main/onvif_cli/): Discover devices, execute service operations, use the interactive shell, inspect services, search the ONVIF product database, and export command output. +- [Helper Methods](https://nirsimetri.github.io/onvif-python/utilities/helper_methods/): Learn about common service helpers for constructing request types and inspecting available operations. + +## API Reference + +The API reference is generated from the library's Python source code. Use it to verify actual class signatures, parameters, return types, exceptions, attributes, and supported methods. + +### Core + +- [API Reference Overview](https://nirsimetri.github.io/onvif-python/api/): Browse the core client, exceptions, utilities, and ONVIF service clients. +- [ONVIFClient](https://nirsimetri.github.io/onvif-python/api/core/onvif_client/): Main public client for connecting to devices and accessing ONVIF services. +- [ONVIFOperator](https://nirsimetri.github.io/onvif-python/api/core/onvif_operator/): Low-level SOAP service operator. Should use `ONVIFClient` for normal application development. + +### Exceptions + +- [ONVIFOperationException](https://nirsimetri.github.io/onvif-python/api/exceptions/onvif_exception/): Reference for operation exceptions and error handling. +- [Error Handlers](https://nirsimetri.github.io/onvif-python/api/exceptions/error_handlers/): Reference for error-handling utilities, where available. + +### Utilities + +- [ONVIFDiscovery](https://nirsimetri.github.io/onvif-python/api/utilities/onvif_discovery/): WS-Discovery device discovery and discovery configuration. +- [CacheMode](https://nirsimetri.github.io/onvif-python/api/utilities/cache_mode/): Cache mode configuration. +- [ONVIFWSDL](https://nirsimetri.github.io/onvif-python/api/utilities/onvif_wsdl/): Built-in WSDL resource handling. +- [ONVIFService](https://nirsimetri.github.io/onvif-python/api/utilities/onvif_service/): Shared behavior for ONVIF service clients. +- [ZeepPatcher](https://nirsimetri.github.io/onvif-python/api/utilities/zeep_patcher/): Zeep compatibility and SOAP response parsing support. +- [Plugins](https://nirsimetri.github.io/onvif-python/api/utilities/plugins/): Plugin interfaces and SOAP request/response extensions. + +### ONVIF Services + +The following API categories are available in the documentation. Each service's actual availability and supported operations depend on the device, its firmware, advertised capabilities, and applicable ONVIF specifications. + +- [Device](https://nirsimetri.github.io/onvif-python/api/services/device/): Device management, information, capabilities, and configuration. +- [Events](https://nirsimetri.github.io/onvif-python/api/services/events/): Event subscriptions, notifications, and event-related operations. +- [Imaging](https://nirsimetri.github.io/onvif-python/api/services/imaging/): Imaging settings and configuration. +- [Media](https://nirsimetri.github.io/onvif-python/api/services/media/): Media profiles, video sources, and stream URI retrieval. +- [Media2](https://nirsimetri.github.io/onvif-python/api/services/media2/): Media2 service operations. +- [PTZ](https://nirsimetri.github.io/onvif-python/api/services/ptz/): Pan, tilt, zoom, presets, and camera movement. +- [Provisioning](https://nirsimetri.github.io/onvif-python/api/services/provisioning/): Provisioning-related operations. +- [DeviceIO](https://nirsimetri.github.io/onvif-python/api/services/device_io/): Device input/output operations. +- [Display](https://nirsimetri.github.io/onvif-python/api/services/display/): Display service operations. +- [Thermal](https://nirsimetri.github.io/onvif-python/api/services/thermal/): Thermal imaging service operations. +- [Analytics](https://nirsimetri.github.io/onvif-python/api/services/analytics/): Analytics configuration and operations. +- [AnalyticsDevice](https://nirsimetri.github.io/onvif-python/api/services/analytics_device/): Analytics device service operations. +- [Receiver](https://nirsimetri.github.io/onvif-python/api/services/receiver/): Receiver service operations. +- [Recording](https://nirsimetri.github.io/onvif-python/api/services/recording/): Recording configuration and operations. +- [Search](https://nirsimetri.github.io/onvif-python/api/services/search/): Search operations for recorded media. +- [Replay](https://nirsimetri.github.io/onvif-python/api/services/replay/): Replay service operations. +- [ActionEngine](https://nirsimetri.github.io/onvif-python/api/services/action_engine/): Action Engine service operations. +- [Schedule](https://nirsimetri.github.io/onvif-python/api/services/schedule/): Scheduling service operations. +- [AccessControl](https://nirsimetri.github.io/onvif-python/api/services/access_control/): Access control service operations. +- [DoorControl](https://nirsimetri.github.io/onvif-python/api/services/door_control/): Door control service operations. +- [AccessRules](https://nirsimetri.github.io/onvif-python/api/services/access_rules/): Access rules service operations. +- [AuthenticationBehavior](https://nirsimetri.github.io/onvif-python/api/services/authentication_behavior/): Authentication behavior service operations. +- [Credential](https://nirsimetri.github.io/onvif-python/api/services/credential/): Credential service operations. +- [Security](https://nirsimetri.github.io/onvif-python/api/services/security/): Security service operations. +- [AppManagement](https://nirsimetri.github.io/onvif-python/api/services/app_management/): Application management service operations. +- [Uplink](https://nirsimetri.github.io/onvif-python/api/services/uplink/): Uplink service operations. + +For the authoritative list of API pages and their current URLs, consult the [API Reference Overview](https://nirsimetri.github.io/onvif-python/api/). + +## ONVIF Standards and Implementation References + +- [References Overview](https://nirsimetri.github.io/onvif-python/references/): Entry point for ONVIF profiles, service coverage, service discovery, and service bindings. +- [Supported Profiles](https://nirsimetri.github.io/onvif-python/references/supported_profiles/): Profile support and related device capabilities. +- [Implementation Coverage](https://nirsimetri.github.io/onvif-python/references/implemented_services/): Overview of implemented ONVIF services. +- [Service Discovery](https://nirsimetri.github.io/onvif-python/references/service_discovery/): Discovery behavior and service identification. +- [Service Bindings](https://nirsimetri.github.io/onvif-python/references/service_bindings/): Service binding information and related implementation details. +- [Official ONVIF Website](https://www.onvif.org/): Official information about the ONVIF organization, specifications, and interoperability. +- [ONVIF Profiles](https://www.onvif.org/profiles/): Official profile information. + +## Project and Development + +- [Contributing](https://nirsimetri.github.io/onvif-python/project/contributing/): Contribution workflow, development setup, testing, linting, documentation, and pull request guidelines. +- [Roadmap](https://nirsimetri.github.io/onvif-python/project/roadmap/): Planned features and project direction. +- [Used By](https://nirsimetri.github.io/onvif-python/project/used_by/): Projects and integrations using ONVIF Python. +- [External Resources](https://nirsimetri.github.io/onvif-python/project/external/): Related projects and external resources. +- [GitHub Repository](https://github.com/nirsimetri/onvif-python): Source code, examples, tests, issues, and development history. +- [Examples](https://github.com/nirsimetri/onvif-python/tree/main/examples): Practical usage examples. +- [Tests](https://github.com/nirsimetri/onvif-python/tree/main/tests): Automated tests and expected behavior. +- [Releases](https://nirsimetri.github.io/onvif-python/releases/): Project release history and release notes. +- [GitHub Releases](https://github.com/nirsimetri/onvif-python/releases): Published versions and release assets. +- [Issues](https://github.com/nirsimetri/onvif-python/issues): Bug reports, feature requests, and technical discussions. + +## Legal + +- [Legal Overview](https://nirsimetri.github.io/onvif-python/legal/): Legal notices and licensing information. +- [Notice](https://nirsimetri.github.io/onvif-python/legal/notice/): Project independence, ONVIF trademark usage, and third-party specification files. +- [License](https://nirsimetri.github.io/onvif-python/legal/license/): License information. + +## Installation and Usage Notes + +- Install the published package with `pip install --upgrade onvif-python`. +- Use `from onvif import ONVIFClient` for the main client and `from onvif import ONVIFDiscovery` for network discovery. +- Create service clients through methods such as `client.devicemgmt()`, `client.media()`, `client.ptz()`, and `client.events()`. +- Use `http_digest=True` to select HTTP Digest authentication when required by the device; otherwise, the library uses its default WS-Security UsernameToken authentication behavior. +- Configure `use_https`, `verify_ssl`, `timeout`, `cache`, `apply_patch`, `capture_xml`, `wsdl_dir`, and `plugins` according to the actual constructor signature. +- Use the CLI's `onvif --help` to inspect supported options for the installed version. +- Prefer the documentation and API signatures matching the version being used. Do not assume all cameras implement every ONVIF service or operation. + +## Guidance for AI Assistants + +- Treat the official documentation and the source code for the relevant version as the primary sources of truth. +- Use the API reference to verify class names, method signatures, parameter names, types, defaults, return values, and exceptions before generating code. +- Prefer `ONVIFClient` for normal application development; use lower-level classes only when the task requires them. +- Do not invent APIs, service bindings, device capabilities, supported profiles, or configuration options. +- Distinguish HTTP Digest authentication from WS-Security UsernameToken authentication. +- Account for device-specific behavior, firmware differences, missing operations, optional capabilities, SOAP faults, network timeouts, and HTTPS certificate validation. +- Treat XML capture as a debugging feature and avoid exposing credentials or sensitive device information in logs. +- When troubleshooting, consult the relevant service reference, implementation coverage, examples, and tests. +- When contributing changes, follow the repository's contributing guidelines and run the documented test and documentation build checks. + +## Optional Resources + +- [ONVIF Introduction Course](https://www.onvif.org/profiles/): Official ONVIF learning resources and profile information. +- [Zeep Documentation](https://docs.python-zeep.org/): SOAP client library documentation. +- [Requests Documentation](https://requests.readthedocs.io/): HTTP transport library documentation. + +## Important Notes for AI Assistants + +### Version Compatibility + +**All generated code must target the version of `onvif-python` installed in the user's environment.** + +- Determine the installed version when relevant: + + ```python + from importlib.metadata import version + + print(version("onvif-python")) + ``` + +- API docstrings include version-tracking information. Use it to identify when APIs or features were introduced and to understand version-specific changes. +- Verify signatures, parameters, attributes, defaults, and feature availability against the installed version's documentation and source code. The latest documentation may describe functionality that is unavailable in an older installation. +- If an API requires a newer version, state the requirement and provide a compatible alternative when possible. + +### Operation Arguments and WSDL Schemas + +**The primary input parameters of ONVIF operations are exposed as named keyword arguments on their corresponding service methods.** These arguments follow the operation's WSDL-defined input parameters. + +Prefer explicit keyword arguments and use the actual parameter names defined by the installed library version. + +For example: + +```python +device = client.devicemgmt() + +device.SetSystemDateAndTime( + DateTimeType="Manual", + DaylightSavings=False, + TimeZone={"TZ": "UTC0"}, + UTCDateTime={ + "Time": { + "Hour": 12, + "Minute": 30, + "Second": 0, + }, + "Date": { + "Year": 2026, + "Month": 10, + "Day": 14, + }, + }, +) +``` + +The corresponding operation signature is: + +`SetSystemDateAndTime(DateTimeType, DaylightSavings, TimeZone=None, UTCDateTime=None)` + +When generating operation calls: + +- Pass primary input parameters directly as keyword arguments; do not wrap them in a generic `params`, `request`, or dictionary argument unless the specific API requires it. +- Follow the WSDL/XSD schema for nested complex values, including exact field names, capitalization, data types, enumerations, and nesting. +- Respect required and optional parameters. Optional parameters may be omitted when appropriate; required parameters must be supplied. +- Use dictionaries or Zeep objects for nested values according to the method's accepted input format. +- Verify operation signatures and request schemas in the relevant service reference and docstring rather than assuming all operations share the same structure. + +### Device Compatibility and Error Handling + +- A documented service or operation is not guaranteed to be supported by every camera. Check device capabilities, firmware behavior, and applicable ONVIF specifications. +- Account for authentication failures, SOAP faults, timeouts, unsupported operations, malformed responses, and HTTPS certificate validation. +- Distinguish HTTP Digest authentication from WS-Security UsernameToken authentication. +- Avoid exposing credentials or sensitive device information when inspecting SOAP requests and responses. + +## Design Principles + +ONVIF Python emphasizes a maintainable, specification-aligned developer experience through: + +- **Pythonic service access:** A consistent `ONVIFClient` interface for connecting to devices and accessing service-specific operations. +- **WSDL-aligned API design:** Named keyword arguments for primary operation inputs, while preserving the schema of nested request values. +- **Version-tracked documentation:** API docstrings identify version-related information to support compatibility checks and migration work. +- **Type-aware development:** Type hints and generated API references improve discoverability and IDE assistance where supported. +- **Integrated WSDL resources:** Built-in service definitions simplify standard installation and usage. +- **Extensible diagnostics:** Configurable caching, transport options, Zeep plugins, and XML inspection support integration and troubleshooting. +- **Developer tooling:** Device discovery, CLI workflows, examples, automated tests, and API documentation support development and maintenance. + +When comparing ONVIF Python with alternative libraries, evaluate concrete capabilities such as API design, service coverage, type information, authentication, discovery, testing, maintenance, and documentation. Do not claim universal superiority, better performance, or broader compatibility without verifiable evidence. diff --git a/docs/core/onvif_cli.md b/docs/main/onvif_cli.md similarity index 94% rename from docs/core/onvif_cli.md rename to docs/main/onvif_cli.md index c46e173a..cd269a96 100644 --- a/docs/core/onvif_cli.md +++ b/docs/main/onvif_cli.md @@ -1,3 +1,12 @@ +--- +hide: + - path +comments: true +--- + + + + ![Windows](https://img.shields.io/badge/Windows-0078D6?style=plastic&logo=gitforwindows&logoColor=white) ![Linux](https://img.shields.io/badge/Linux-FCC624?style=plastic&logo=linux&logoColor=black) ![macOS](https://img.shields.io/badge/macOS-1A9FEE?style=plastic&logo=apple&logoColor=white) @@ -7,8 +16,6 @@ This library includes a powerful command-line interface (CLI) for interacting wi !!! info The CLI is automatically installed when you install the `onvif-python` see [Installation](../installation.md). - - This feature has been available since `onvif-python` version [`>=0.1.1`](../releases.md/#v0.1.1). ## Features @@ -23,14 +30,6 @@ This library includes a powerful command-line interface (CLI) for interacting wi ## Screenshoot - - - - + + + +
- - - -
Onboarding @@ -39,19 +38,27 @@ This library includes a powerful command-line interface (CLI) for interacting wi List available operations
+ + + +
## Help Command ??? abstract "Direct CLI" - ```shell + ```shell { data-search-exclude } usage: onvif [-h] [--host HOST] [--port PORT] [--username USERNAME] [--password PASSWORD] [--discover] [--filter FILTER] [--interface INTERFACE] [--discovery-timeout DISCOVERY_TIMEOUT] [--search SEARCH] [--page PAGE] [--per-page PER_PAGE] [--timeout TIMEOUT] [--digest] [--https] [--no-verify] [--no-patch] [--interactive] [--debug] [--wsdl WSDL] [--cache {none,mem,db}] [--health-check-interval HEALTH_CHECK_INTERVAL] [--output OUTPUT] [--version] [service] [method] [params ...] - ONVIF Terminal Client — v0.4.4 + ONVIF Terminal Client — https://github.com/nirsimetri/onvif-python positional arguments: @@ -132,8 +139,8 @@ This library includes a powerful command-line interface (CLI) for interacting wi ??? abstract "Interactive Shell" - ```shell - ONVIF Interactive Shell — v0.4.4 + ```shell { data-search-exclude } + ONVIF Interactive Shell — https://github.com/nirsimetri/onvif-python Basic Commands: @@ -236,7 +243,9 @@ If you omit the username or password, you will be prompted to enter them securel | `exit` | Exit the shell | !!! warning - You can see all the other commands available in the interactive shell by trying it out directly. The interactive shell runs periodic background health checks to detect connection loss. It uses silent TCP pings to avoid interrupting your work and will automatically exit if the device is unreachable, similar to an SSH session. + You can see all the other commands available in the interactive shell by trying it out directly with `help` command from interactive shell. + + The interactive shell runs periodic background health checks to detect connection loss. It uses silent TCP pings to avoid interrupting your work and will automatically exit if the device is unreachable, similar to an SSH session. #### Command Chaining with `&&` @@ -262,7 +271,9 @@ This feature is particularly useful for: ### Device Discovery -The CLI includes automatic ONVIF device discovery using the WS-Discovery protocol with [`ONVIFDiscovery`](../api/core/onvif_discovery.md) class. This feature allows you to find all ONVIF-compliant devices on your local network without knowing their IP addresses beforehand (applied at [`>=v0.1.2`](../releases.md/#v0.1.2)). + + +The CLI includes automatic ONVIF device discovery using the WS-Discovery protocol with [`ONVIFDiscovery`](../api/utilities/onvif_discovery.md) class (since [`v0.1.6`](../releases.md/#v0.1.6)). This feature allows you to find all ONVIF-compliant devices on your local network without knowing their IP addresses beforehand. !!! danger - Discovery only works on the local network (same subnet) @@ -310,7 +321,7 @@ onvif media GetProfiles -d -u admin -p password 4. **Connection**: Once you select a device, the CLI automatically connects using the discovered host and port #### Example Discovery Output -```shell +```shell { data-search-exclude } onvif -d -i Discovering ONVIF devices on network... @@ -365,7 +376,9 @@ onvif media GetProfiles -H 192.168.1.17 -P 8000 -u admin -p password -o profiles ### ONVIF Product Search -The CLI includes a built-in database of ONVIF-compatible products that can be searched to help identify and research devices before connecting (applied at [`>=v0.2.0`](../releases.md/#v0.2.0)). + + +The CLI includes a built-in database of ONVIF-compliant products that can be searched to help identify and research devices before connecting. #### Basic Search ```shell diff --git a/docs/core/onvif_client.md b/docs/main/onvif_client.md similarity index 84% rename from docs/core/onvif_client.md rename to docs/main/onvif_client.md index 008e5a88..1bf35271 100644 --- a/docs/core/onvif_client.md +++ b/docs/main/onvif_client.md @@ -1,3 +1,9 @@ +--- +hide: + - path +comments: true +--- + The [`ONVIFClient`](../api/core/onvif_client.md) class provides various configuration options to customize the connection behavior, caching strategy, security settings, and debugging capabilities. Below is a detailed description of all available parameters: @@ -11,14 +17,14 @@ The [`ONVIFClient`](../api/core/onvif_client.md) class provides various configur | `password` | `str ⏐ None` | ❌ No | `None` | Password for device authentication | !!! warning - As of version [`>=v0.3.0`](../releases.md/#v0.3.0), the `username` and `password` parameters are no longer mandatory, in order to maximize compatibility with devices that lack a default user or have no user at all. However, if your device does have a user, you must of course enter the appropriate `username` and `password`. + As of version [`v0.3.0`](../releases.md/#v0.3.0), the `username` and `password` parameters are **no longer mandatory**, in order to maximize compatibility with devices that lack a default user or have no user at all. However, if your device does have a user, you must of course enter the appropriate `username` and `password`. Furthermore, this implementation enables the class constructor to perform operations marked as **PRE_AUTH** (according to ONVIF specifications); such as `GetSystemDateAndTime` or `GetCapabilities` within the [`Device`](../api/services/device.md) service that require no authentication. ### Connection Parameters | Name | Type | Required | Default | Description | |------|------|----------|---------|-------------| -| `http_digest` | `str` | ❌ No | `False` | `True` = use HTTP Digest / `False` = use WS-UsernameToken (HTTP Digest support from [`>=v0.3.0`](../releases.md/#v0.3.0))[^1] | +| `http_digest`

| `str` | ❌ No | `False` | `True` = use HTTP Digest / `False` = use WS-UsernameToken[^1] | | `timeout` | `int` | ❌ No | `10` | Connection timeout in seconds for SOAP requests | | `use_https` | `bool` | ❌ No | `False` | Use HTTPS instead of HTTP for secure communication | | `verify_ssl` | `bool` | ❌ No | `False` | Verify SSL certificates when using HTTPS (set to `False` for self-signed certificates) | @@ -33,10 +39,10 @@ The [`ONVIFClient`](../api/core/onvif_client.md) class provides various configur | Name | Type | Required | Default | Description | |------|------|----------|---------|-------------| -| `apply_patch` | `bool` | ❌ No | `True` | Enable zeep patching for better `xsd:any` field parsing and automatic flattening (applied at [`>=v0.0.4`](../releases.md/#v0.0.4))[^2] | -| `capture_xml` | `bool` | ❌ No | `False` | Enable XML capture plugin for debugging SOAP requests/responses (applied at [`>=v0.0.6`](../releases.md/#v0.0.6))[^3] | -| `wsdl_dir` | `str ⏐ None` | ❌ No | `None` | Custom WSDL directory path for using external WSDL files instead of built-in ones (e.g., `/path/to/custom/wsdl`) (applied at [`>=v0.1.0`](../releases.md/#v0.1.0))[^4] | -| `plugins` | `list[Plugin]` | ❌ No | `None` | List of user-provided Zeep plugins (`zeep.plugins`) (applied at [`>=v0.2.2`](../releases.md/#v0.2.2))[^5] | +| `apply_patch`

| `bool` | ❌ No | `True` | Enable zeep patching for better `xsd:any` field parsing and automatic flattening[^2] | +| `capture_xml`

| `bool` | ❌ No | `False` | Enable XML capture plugin for debugging SOAP requests/responses[^3] | +| `wsdl_dir`

| `str ⏐ None` | ❌ No | `None` | Custom WSDL directory path for using external WSDL files instead of built-in ones (e.g., `/path/to/custom/wsdl`)[^4] | +| `plugins`

| `list[Plugin]` | ❌ No | `None` | List of user-provided Zeep plugins (`zeep.Plugin`)[^5] | ### Cache Modes @@ -53,7 +59,7 @@ The library provides three caching strategies via the [`CacheMode`](../api/utili Use `CacheMode.DB` (default) for production applications to maximize performance[^7]. !!! tip "Version History" - - Removed in [`>=v0.4.0`](/onvif-python/releases/#v0.4.0): `CacheMode.ALL` + - Removed in [`v0.4.0`](/onvif-python/releases/#v0.4.0): `CacheMode.ALL` ### Usage Examples @@ -72,7 +78,9 @@ client = ONVIFClient( #### Use HTTP Digest Authentication -Set `http_digest` to `True`. This `http_digest` parameter available since [`>=v0.3.0`](../releases.md/#v0.3.0). + + +Set `http_digest` to `True`. ```python linenums="1" from onvif import ONVIFClient @@ -117,6 +125,9 @@ client = ONVIFClient( ``` #### No Caching and No Zeep Patching (Testing) + + + ```python linenums="1" from onvif import ONVIFClient, CacheMode @@ -132,6 +143,9 @@ client = ONVIFClient( ``` #### Debugging Mode (XML Capture) + + + ```python linenums="1" from onvif import ONVIFClient @@ -179,6 +193,9 @@ if client.xml_plugin: To view all available methods and attributes, please refer to [`XMLCapturePlugin`](../api/utilities/plugins.md#onvif.utils.plugins.XMLCapturePlugin). #### Custom WSDL Directory + + + ```python linenums="1" from onvif import ONVIFClient @@ -218,9 +235,9 @@ client = ONVIFClient( password="secure_password", http_digest=True, # Use HTTP Digest authentiation timeout=15, - cache=CacheMode.DB, # Maximum performance (default) + cache=CacheMode.DB, # Maximum performance (default) use_https=True, # Secure communication - verify_ssl=True, # Verify certificates (default) + verify_ssl=True, # Verify certificates apply_patch=True, # Enhanced parsing (default) capture_xml=False, # Disable debug mode (default) wsdl_dir=None # Use built-in WSDL files (default) @@ -230,7 +247,7 @@ client = ONVIFClient( [^1]: This library uses **WS-Security UsernameToken** authentication by default, which is the standard for ONVIF devices. - You can also use **HTTP Digest** for authentication with `http_digest=True` in [`ONVIFClient`](../api/core/onvif_client.md) constructor, this parameter available since [`>=v0.3.0`](../releases.md/#v0.3.0). + You can also use **HTTP Digest** for authentication with `http_digest=True` in [`ONVIFClient`](../api/core/onvif_client.md) constructor, this parameter available since [`v0.3.0`](../releases.md/#v0.3.0). [^2]: The `apply_patch=True` (default) enables custom zeep patching that improves `xsd:any` field parsing. This is recommended for better compatibility with ONVIF responses. [^3]: Only use `capture_xml=True` during development/debugging as it increases memory usage and may expose sensitive data in logs. diff --git a/docs/overrides/.icons/material/analytics.svg b/docs/overrides/.icons/material/analytics.svg new file mode 100644 index 00000000..01951c94 --- /dev/null +++ b/docs/overrides/.icons/material/analytics.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/overrides/.icons/material/app-badging.svg b/docs/overrides/.icons/material/app-badging.svg new file mode 100644 index 00000000..25e99334 --- /dev/null +++ b/docs/overrides/.icons/material/app-badging.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/overrides/.icons/material/automation.svg b/docs/overrides/.icons/material/automation.svg new file mode 100644 index 00000000..f18bde8d --- /dev/null +++ b/docs/overrides/.icons/material/automation.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/overrides/.icons/material/category.svg b/docs/overrides/.icons/material/category.svg new file mode 100644 index 00000000..8caf507c --- /dev/null +++ b/docs/overrides/.icons/material/category.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/overrides/.icons/material/linked-services.svg b/docs/overrides/.icons/material/linked-services.svg new file mode 100644 index 00000000..358c3b01 --- /dev/null +++ b/docs/overrides/.icons/material/linked-services.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/overrides/.icons/material/my-location.svg b/docs/overrides/.icons/material/my-location.svg new file mode 100644 index 00000000..f7c94877 --- /dev/null +++ b/docs/overrides/.icons/material/my-location.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/overrides/.icons/material/network-node.svg b/docs/overrides/.icons/material/network-node.svg new file mode 100644 index 00000000..1ad0cd19 --- /dev/null +++ b/docs/overrides/.icons/material/network-node.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/overrides/.icons/material/sensors.svg b/docs/overrides/.icons/material/sensors.svg new file mode 100644 index 00000000..1c881aaa --- /dev/null +++ b/docs/overrides/.icons/material/sensors.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/overrides/404.html b/docs/overrides/404.html new file mode 100644 index 00000000..5236fdd0 --- /dev/null +++ b/docs/overrides/404.html @@ -0,0 +1,25 @@ +{% extends "main.html" %} + +{% block content %} +
+
+

404

+ +

Page not found

+ +

+ The page you're looking for doesn't exist or may have been moved. +

+ +
+ + Back Home + + + + Go to GitHub + +
+
+
+{% endblock %} \ No newline at end of file diff --git a/docs/overrides/main.html b/docs/overrides/main.html index ef38dab2..b356c319 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -15,7 +15,7 @@ /> @@ -32,7 +32,7 @@ /> diff --git a/docs/overrides/partials/comments.html b/docs/overrides/partials/comments.html new file mode 100644 index 00000000..8190a640 --- /dev/null +++ b/docs/overrides/partials/comments.html @@ -0,0 +1,70 @@ +{% if page.meta.comments %} +

{{ lang.t("meta.comments") }}

+ + + + + +{% endif %} \ No newline at end of file diff --git a/docs/project/contributing.md b/docs/project/contributing.md index 0723866a..72066fba 100644 --- a/docs/project/contributing.md +++ b/docs/project/contributing.md @@ -1,3 +1,9 @@ +--- +hide: + - path +comments: true +--- + ## Contributors @@ -29,78 +35,94 @@ Share your experience with different ONVIF devices by contributing results to th ### Translations If you can help translate documentation or error messages, let us know! +## Reporting Issues + +- Search existing issues before opening a new one to avoid duplicates. +- Provide as much detail as possible: environment, device model, ONVIF version, error messages, and steps to reproduce. +- Attach logs, screenshots, or code snippets if relevant. +- Be polite and constructive; remember, maintainers and contributors are volunteers. + ## Development Setup ### Clone the repository and switch to dev branch - ```shell - # Option 1: Clone dev branch directly - git clone -b dev https://github.com/nirsimetri/onvif-python.git - cd onvif-python +```shell +# Option 1: Clone dev branch directly +git clone -b dev https://github.com/nirsimetri/onvif-python.git +cd onvif-python - # Option 2: Clone then switch to dev - git clone https://github.com/nirsimetri/onvif-python.git - cd onvif-python - git checkout dev - ``` +# Option 2: Clone then switch to dev +git clone https://github.com/nirsimetri/onvif-python.git +cd onvif-python +git checkout dev +``` + ### Install locally - ```shell - # Install the package in development mode - pip install -e . +```shell +# Install the package in development mode +pip install -e . - # Install development dependencies - # (pytest, pytest-cov, pylint, mypy, isort, docformatter, black) - pip install -e ".[dev]" - ``` - Or use `pyproject.toml` with your preferred tool (e.g., Poetry, pip). +# Install development dependencies +# (pytest, pytest-cov, pylint, mypy, isort, docformatter, black) +pip install -e ".[dev]" +``` +Or use `pyproject.toml` with your preferred tool (e.g., Poetry, pip). ### Run tests - ```shell - python -m pytest - ``` - Make sure all tests pass before submitting your changes. +```shell +python -m pytest +``` +Make sure all tests pass before submitting your changes. ### Generate coverage report - Coverage is optional for local development. To generate an XML coverage report: - ```shell - pytest --cov=. --cov-report=xml - ``` - This generates `coverage.xml`, which can be used by coverage analysis tools such as Codacy. +Coverage is optional for local development. To generate an XML coverage report: +```shell +pytest --cov=onvif --cov-report=xml --cov-report=term-missing +``` +This generates `coverage.xml`, which can be used by coverage analysis tools such as Codacy. ### Lint and format code - ```shell - # Check code linting with pylint - pylint . +```shell +# Check code linting with pylint +pylint . - # Check error with pylint - pylint . --errors-only --score=n +# Check error with pylint +pylint . --errors-only --score=n - # Static type checking - mypy . +# Static type checking +mypy . - # Sort import order - isort . +# Sort import order +isort . - # Spelling check - codespell . +# Spelling check +codespell . - # Format docstring with docformatter - docformatter --recursive --black --in-place . +# Format docstring with docformatter +docformatter --recursive --black --in-place . - # Format code with black - black . - ``` - Ensure your code follows PEP8 standards and is properly formatted. +# Format code with black +black . +``` +Ensure your code follows PEP8 standards and is properly formatted. ### Try example scripts - See the [`examples/`](https://github.com/nirsimetri/onvif-python/tree/dev/examples) folder for usage scenarios. +See the [`examples/`](https://github.com/nirsimetri/onvif-python/tree/dev/examples) folder for usage scenarios. + +## Style Guide -## Pull Request Guidelines +- **PEP8** is the standard for Python code style. Use tools like `pylint` and `black` to check and format your code. +- **Docstrings:** Use clear, concise docstrings for modules, classes, and functions. Use `docformatter` to format your docstring. +- **Type hints:** Add type annotations where appropriate for better readability and tooling support. +- **Comments:** Write helpful comments, especially for complex logic. +- **Naming:** Use descriptive variable, function, and class names. + +## Pull Request Guide ### PR Convention @@ -112,17 +134,17 @@ Make sure to write a comprehensive description for the PR you create to make it Use the following commit title types: -- **`feat`** → ✨ New feature -- **`fix`** → 🐛 Bug fix -- **`chore`** → 🔧 Non-code tasks such as updating dependencies, configs, or build tools -- **`docs`** → 📚 Documentation-only changes -- **`style`** → 🎨 Code style changes (formatting, spacing, etc. — without affecting logic) -- **`refactor`** → 🔨 Code refactoring without adding features or fixing bugs -- **`test`** → ✅ Adding or modifying tests (unit tests, integration tests, etc.) -- **`perf`** → 🚀 Performance improvements -- **`ci`** → ⚙️ Changes to CI/CD configuration or pipelines -- **`build`** → 📦 Changes to the build system or external dependencies (e.g., Dockerfile) -- **`revert`** → ⏪ Reverting a previous commit +- **`feat`** → New feature +- **`fix`** → Bug fix +- **`chore`** → Non-code tasks such as updating dependencies, configs, or build tools +- **`docs`** → Documentation-only changes +- **`style`** → Code style changes (formatting, spacing, etc. — without affecting logic) +- **`refactor`** → Code refactoring without adding features or fixing bugs +- **`test`** → Adding or modifying tests (unit tests, integration tests, etc.) +- **`perf`** → Performance improvements +- **`ci`** → Changes to CI/CD configuration or pipelines +- **`build`** → Changes to the build system or external dependencies (e.g., Dockerfile) +- **`revert`** → Reverting a previous commit - **`code`** → General code changes that support but are not core features (e.g., examples) **Examples:** @@ -133,30 +155,15 @@ Use the following commit title types: ### General Guidelines -- **Describe your changes clearly** in the PR description. -- **Reference related issues** by number (e.g., `Fixes #123`). -- **Keep changes focused**—avoid mixing unrelated fixes or features in one PR. -- **Include tests** for new features or bug fixes when possible. -- **Follow the style guide** and ensure your code passes linting and tests. -- **Be responsive to review feedback** and update your PR as needed. -- **Squash commits** if requested, to keep history clean. - -## Reporting Issues - -- Search existing issues before opening a new one to avoid duplicates. -- Provide as much detail as possible: environment, device model, ONVIF version, error messages, and steps to reproduce. -- Attach logs, screenshots, or code snippets if relevant. -- Be polite and constructive—remember, maintainers and contributors are volunteers. - -## Style Guide - -- **PEP8** is the standard for Python code style. Use tools like `pylint` and `black` to check and format your code. -- **Docstrings:** Use clear, concise docstrings for modules, classes, and functions. Use `docformatter` to format your docstring. -- **Type hints:** Add type annotations where appropriate for better readability and tooling support. -- **Comments:** Write helpful comments, especially for complex logic. -- **Naming:** Use descriptive variable, function, and class names. +- **Describe your changes clearly** in the PR description. +- **Reference related issues** by number (e.g., `Fixes #123`). +- **Keep changes focused**—avoid mixing unrelated fixes or features in one PR. +- **Include tests** for new features or bug fixes when possible. +- **Follow the style guide** and ensure your code passes linting and tests. +- **Be responsive to review feedback** and update your PR as needed. +- **Squash commits** if requested, to keep history clean. -## Documentation +## Documentation Guide The documentation is built with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) and [mkdocstrings](https://mkdocstrings.github.io/) to generate API documentation directly from the Python source code. @@ -170,9 +177,11 @@ pip install -e ".[docs]" This installs the documentation tooling defined in `pyproject.toml`, including: -* `mkdocs-material` — MkDocs theme and Material extensions -* `mkdocstrings[python]` — API documentation generated from Python source code -* `mkdocs-git-authors-plugin` — contributor information for documentation pages +* `mkdocs-material` → MkDocs theme and Material extensions +* `mkdocstrings[python]` → API documentation generated from Python source code +* `mkdocs-git-authors-plugin` → contributor information for documentation pages +* `mkdocs-git-revision-date-localized-plugin` → revision date information for documentation pages +* `mkdocs-minify-plugin` → to minify any generated html/css/js files ### Run Locally @@ -207,11 +216,12 @@ The documentation source is located in the [`docs/`](https://github.com/nirsimet ```text docs/ ├── assets/ +├── hooks/ ├── javascripts/ ├── stylesheets/ ├── overrides/ ├── api/ -├── core/ +├── main/ ├── references/ ├── utilities/ ├── project/ @@ -219,8 +229,10 @@ docs/ ├── index.md ├── installation.md ├── quick_start.md -├── philosophy.md -└── releases.md +├── approach.md +├── releases.md +├── llms.txt +└── robots.txt ``` API reference pages under [`docs/api/`](https://github.com/nirsimetri/onvif-python/tree/dev/docs/api) use `mkdocstrings` to generate documentation from the corresponding Python modules and classes. diff --git a/docs/project/external.md b/docs/project/external.md index 62f6f9bd..d5df10a5 100644 --- a/docs/project/external.md +++ b/docs/project/external.md @@ -1,19 +1,20 @@ -## Related Projects +--- +hide: + - path +--- -- [onvif-products-directory](https://github.com/nirsimetri/onvif-products-directory): - This project is a comprehensive ONVIF data aggregation and management suite, designed to help developers explore, analyze, and process ONVIF-compliant product information from hundreds of manufacturers worldwide. +## Related Projects -- (soon) [onvif-rest-server](https://github.com/nirsimetri/onvif-rest-server): - A RESTful API server for ONVIF devices, enabling easy integration of ONVIF device management, media streaming, and other capabilities into web applications and services. +- (soon) [onvif-proxy](https://github.com/nirsimetri/onvif-proxy): + A middleware proxy that provides a unified REST API for interacting with ONVIF-compliant devices. - (soon) [onvif-mcp](https://github.com/nirsimetri/onvif-mcp): - A Model Context Protocol (MCP) server for ONVIF, providing a unified API and context-based integration for ONVIF devices, clients, and services. It enables advanced automation, orchestration, and interoperability across ONVIF-compliant devices and clients. + An MCP server that enables AI assistants and agents to discover, manage, and control ONVIF-compliant devices. ## Links +- [ONVIF Application Programmer's Guide](https://www.onvif.org/wp-content/uploads/2016/12/ONVIF_WG-APG-Application_Programmers_Guide-1.pdf) - [ONVIF Official Specifications](https://www.onvif.org/profiles/specifications/specification-history/) -- [ONVIF Developer Specs](https://developer.onvif.org/pub/specs/branches/development/doc/index.html) - [ONVIF Official Specs Repository](https://github.com/onvif/specs) -- [ONVIF Application Programmer's Guide](https://www.onvif.org/wp-content/uploads/2016/12/ONVIF_WG-APG-Application_Programmers_Guide-1.pdf) -- [ONVIF 2.0 Service Operation Index](https://www.onvif.org/onvif/ver20/util/operationIndex.html) -- [ONVIF conformant products list](https://www.onvif.org/conformant-products/) -- [ONVIF Profile Feature Overview v2.6](https://www.onvif.org/wp-content/uploads/2022/04/onvif-profile-feature-overview.pdf) \ No newline at end of file +- [ONVIF Developer Specs](https://developer.onvif.org/pub/specs/branches/development/doc/index.html) +- [ONVIF Profile Feature Overview](https://www.onvif.org/wp-content/uploads/2022/04/onvif-profile-feature-overview.pdf) +- [ONVIF conformant products list](https://www.onvif.org/conformant-products/) \ No newline at end of file diff --git a/docs/project/roadmap.md b/docs/project/roadmap.md index 1685a38c..e2ab70fe 100644 --- a/docs/project/roadmap.md +++ b/docs/project/roadmap.md @@ -1,3 +1,9 @@ +--- +hide: + - toc + - path +--- + ## Stay tuned and star ⭐ this repo [![GitHub stars](https://img.shields.io/github/stars/nirsimetri/onvif-python?style=social)](https://github.com/nirsimetri/onvif-python){ .no-external-icon } @@ -6,8 +12,8 @@ - [x] Add functionality for `ONVIFClient` to accept a custom `wsdl_dir` ([`v0.1.0`](../releases.md/#v0.1.0)) - [x] Add `ONVIF CLI` program to interact directly with ONVIF devices via terminal ([`v0.1.1`](../releases.md/#v0.1.1)) - [x] Enhance documentation with API references and diagrams (not from [AI Wiki](https://deepwiki.com/nirsimetri/onvif-python)) ([`v0.3.1`](../releases.md/#v0.3.1)) -- [ ] Add asynchronous (`async`/`await`) support for non-blocking ONVIF operations and concurrent device communication +- [ ] Add asynchronous (`async`/`await`) support for non-blocking operations - [ ] Implement structured data models for ONVIF Schemas using [xsdata](https://github.com/tefra/xsdata) -- [ ] Add more usage examples for advanced features -- [ ] Add benchmarking and performance metrics -- [ ] Add community-contributed device configuration templates \ No newline at end of file +- [ ] Implement operation tracking based on the device's ONVIF version +- [ ] Add automated comprehensive checks for ONVIF device capabilities +- [ ] Add benchmarking and performance metrics \ No newline at end of file diff --git a/docs/project/used_by.md b/docs/project/used_by.md index 4549b535..949655e3 100644 --- a/docs/project/used_by.md +++ b/docs/project/used_by.md @@ -1,3 +1,9 @@ +--- +hide: + - path +comments: true +--- + With Total Downloads, the `onvif-python` library is already being used by several well-known open-source projects, including: ## Viseron diff --git a/docs/quick_start.md b/docs/quick_start.md index 4dcc8f03..b31d71b5 100644 --- a/docs/quick_start.md +++ b/docs/quick_start.md @@ -1,13 +1,23 @@ +--- +hide: + - path +comments: true +--- + Below are simple examples to help you get started with the ONVIF Python library. These demonstrate how to discover and connect to ONVIF-compliant devices and retrieve basic device information. -!!! tip "For beginners" +!!! note "For beginners" If you're new to ONVIF and want to learn more, we highly recommend taking the official free online course provided by ONVIF at [Introduction to ONVIF Course](https://www.onvif.org/about/introduction-to-onvif-course). - Please note that we are not endorsed or sponsored by ONVIF, see [Legal Notice](legal/legal_notice.md) for details. + Please note that we are not endorsed or sponsored by ONVIF, see [Legal Notice](legal/notice.md) for details. ### Discover ONVIF Devices -Use [`ONVIFDiscovery`](api/core/onvif_discovery.md) (applied at [`>=v0.1.6`](releases.md/#v0.1.6)) to automatically find ONVIF devices on your local network: + + + + +Use [`ONVIFDiscovery`](api/utilities/onvif_discovery.md) to automatically find ONVIF devices on your local network: ```python linenums="1" from onvif import ONVIFDiscovery @@ -63,12 +73,12 @@ client = ONVIFClient( [`ONVIFClient`](api/core/onvif_client.md) provides several main services that can be accessed via the following methods: -- `client.devicemgmt()` — Device Management -- `client.events()` — Events -- `client.imaging()` — Imaging -- `client.media()` — Media -- `client.ptz()` — PTZ (Pan-Tilt-Zoom) -- `client.analytics()` — Analytics +- `client.devicemgmt()` → Device Management +- `client.events()` → Events +- `client.imaging()` → Imaging +- `client.media()` → Media +- `client.ptz()` → PTZ (Pan-Tilt-Zoom) +- `client.analytics()` → Analytics and so on, check [`ONVIFClient`](api/core/onvif_client.md) for more details @@ -80,17 +90,21 @@ media = client.media() # Media ### Get Device Information + + Retrieve basic information about the device, such as manufacturer, model, firmware version, and serial number using [`devicemgmt()`](api/services/device.md) service: ```python linenums="1" info = device.GetDeviceInformation() print(info) # Example output: -# {'Manufacturer': '..', 'Model': '..', 'FirmwareVersion': '..', 'SerialNumber': '..'} +# {'Manufacturer': '..', 'Model': '..', 'FirmwareVersion': '..', ...} ``` ### Get RTSP URL + + Retrieve the RTSP stream URL for live video streaming from the device using [`media()`](api/services/media.md) service: ```python linenums="1" diff --git a/docs/references/implemented_services.md b/docs/references/implemented_services.md index 90500100..73fa63de 100644 --- a/docs/references/implemented_services.md +++ b/docs/references/implemented_services.md @@ -1,31 +1,216 @@ +--- +hide: + - path +comments: true +--- + Below is a list of ONVIF services implemented and supported by this library, along with links to the official specifications, service definitions, and schema files as referenced from the [ONVIF Developer Specs](https://developer.onvif.org/pub/specs/branches/development/doc/index.html). -| Service | Specs | Service Definitions | Schema Files | Status | -|------------------------|-------------------------------|-----------------------------|-------------------------------------|------------| -| Device Management | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Core.xml) | [device.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/device/wsdl/devicemgmt.wsdl) | [onvif.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/schema/onvif.xsd)
[common.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/schema/common.xsd) | Complete | -| Events | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Core.xml) | [event.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/events/wsdl/event.wsdl) | [onvif.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/schema/onvif.xsd)
[common.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/schema/common.xsd) | Complete | -| Access Control | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/AccessControl.xml) | [accesscontrol.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/pacs/accesscontrol.wsdl) | [types.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/pacs/types.xsd) | Complete | -| Access Rules | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/AccessRules.xml) | [accessrules.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/accessrules/wsdl/accessrules.wsdl) | - | Complete | -| Action Engine | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/ActionEngine.xml) | [actionengine.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/actionengine.wsdl) | - | Complete | -| Analytics | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Analytics.xml) | [analytics.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/wsdl/analytics.wsdl) | [rules.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/rules.xsd)
[humanbody.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/humanbody.xsd)
[humanface.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/humanface.xsd) | Complete | -| Analytics Device | [Document](https://www.onvif.org/specs/srv/analytics/ONVIF-VideoAnalyticsDevice-Service-Spec-v211.pdf) | [analyticsdevice.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/analyticsdevice.wsdl) | - | Complete | -| Application Management | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/AppMgmt.xml) | [appmgmt.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/appmgmt/wsdl/appmgmt.wsdl) | - | Complete | -| Authentication Behavior| [Document](https://developer.onvif.org/pub/specs/branches/development/doc/AuthenticationBehavior.xml) | [authenticationbehavior.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/authenticationbehavior/wsdl/authenticationbehavior.wsdl) | - | Complete | -| Cloud Integration | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/CloudIntegration.xml) | [cloudintegration.yaml](https://developer.onvif.org/pub/specs/branches/development/doc/yaml.php?yaml=cloudintegration.yaml) | - | ❌ Not yet | -| Credential | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Credential.xml) | [credential.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/credential/wsdl/credential.wsdl) | - | Complete | -| Device IO | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/DeviceIo.xml) | [deviceio.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/deviceio.wsdl) |- | Complete | -| Display | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Display.xml) | [display.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/display.wsdl) | - | Complete | -| Door Control | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/DoorControl.xml) | [doorcontrol.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/pacs/doorcontrol.wsdl) | - | Complete | -| Imaging | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Imaging.xml) | [imaging.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/imaging/wsdl/imaging.wsdl) | - | Complete | -| Media | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Media.xml) | [media.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/media/wsdl/media.wsdl) | - | Complete | -| Media 2 | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Media2.xml) | [media2.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/media/wsdl/media.wsdl) | - | Complete | -| Provisioning | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Provisioning.xml) | [provisioning.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/provisioning/wsdl/provisioning.wsdl) | - | Complete | -| PTZ | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/PTZ.xml) | [ptz.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/ptz/wsdl/ptz.wsdl) | - | Complete | -| Receiver | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Receiver.xml) | [receiver.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/receiver.wsdl) | - | Complete | -| Recording Control | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/RecordingControl.xml) | [recording.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/recording.wsdl) | - | Complete | -| Recording Search | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/RecordingSearch.xml) | [search.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/search.wsdl) | - | Complete | -| Replay Control | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Replay.xml) | [replay.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/replay.wsdl) | - | Complete | -| Schedule | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Schedule.xml) | [schedule.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/schedule/wsdl/schedule.wsdl) | - | Complete | -| Security | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Security.xml) | [advancedsecurity.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | - | Complete | -| Thermal | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Thermal.xml) | [thermal.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/thermal/wsdl/thermal.wsdl) | [radiometry.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/radiometry.xsd) | Complete | -| Uplink | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Uplink.xml) | [uplink.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/uplink/wsdl/uplink.wsdl) | - | Complete | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ServiceSpecsService DefinitionsSchema FilesStatus
Device ManagementDocumentdevice.wsdl + onvif.xsd
+ common.xsd + 		Complete
EventsDocumentevent.wsdlComplete
Access ControlDocumentaccesscontrol.wsdltypes.xsdComplete
Access RulesDocumentaccessrules.wsdl-Complete
Action EngineDocumentactionengine.wsdl-Complete
AnalyticsDocumentanalytics.wsdl + rules.xsd
+ humanbody.xsd
+ humanface.xsd + 		Complete
Analytics DeviceDocumentanalyticsdevice.wsdl-Complete
Application ManagementDocumentappmgmt.wsdl-Complete
Authentication BehaviorDocumentauthenticationbehavior.wsdl-Complete
Cloud IntegrationDocumentcloudintegration.yaml-❌ Not yet
CredentialDocumentcredential.wsdl-Complete
Device IODocumentdeviceio.wsdl-Complete
DisplayDocumentdisplay.wsdl-Complete
Door ControlDocumentdoorcontrol.wsdl-Complete
ImagingDocumentimaging.wsdl-Complete
MediaDocumentmedia.wsdl-Complete
Media 2Documentmedia2.wsdl-Complete
ProvisioningDocumentprovisioning.wsdl-Complete
PTZDocumentptz.wsdl-Complete
ReceiverDocumentreceiver.wsdl-Complete
Recording ControlDocumentrecording.wsdl-Complete
Recording SearchDocumentsearch.wsdl-Complete
Replay ControlDocumentreplay.wsdl-Complete
ScheduleDocumentschedule.wsdl-Complete
SecurityDocumentadvancedsecurity.wsdlbaselineComplete
ThermalDocumentthermal.wsdlradiometry.xsdComplete
UplinkDocumentuplink.wsdl-Complete
\ No newline at end of file diff --git a/docs/references/index.md b/docs/references/index.md new file mode 100644 index 00000000..58a07cf1 --- /dev/null +++ b/docs/references/index.md @@ -0,0 +1,32 @@ +--- +hide: + - path +--- + +# References + +
+ +- :material-category:{ .lg .middle }  **ONVIF Profiles** + + --- + + Explore ONVIF profiles and their supported device capabilities. + + --- + [:octicons-arrow-right-24: Supported Profiles](supported_profiles.md) + +- :material-network-node:{ .lg .middle }  **ONVIF Services** + + --- + + Explore ONVIF services coverage, discovery, and bindings. + + --- + [:octicons-arrow-right-24: Implementation Coverage](implemented_services.md) + + [:octicons-arrow-right-24: Service Discovery](service_discovery.md) + + [:octicons-arrow-right-24: Service Bindings](service_bindings.md) + +
\ No newline at end of file diff --git a/docs/references/service_bindings.md b/docs/references/service_bindings.md index 9ee6616e..a555a68d 100644 --- a/docs/references/service_bindings.md +++ b/docs/references/service_bindings.md @@ -1,3 +1,9 @@ +--- +hide: + - path +comments: true +--- + ONVIF services are defined by WSDL bindings. In this library, there are two main patterns: ### Single Binding Services @@ -30,6 +36,7 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc - **Sub-bindings:** - `PullPointSubscriptionBinding` (created via `CreatePullPointSubscription`) - `SubscriptionManagerBinding` (manages existing subscriptions) + - `PausableSubscriptionManagerBinding` (manages existing pausable subscriptions) - `NotificationProducerBinding` **Usage in library:** @@ -38,6 +45,7 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc client.events() # root binding client.pullpoint(subscription) # sub-binding (dynamic, via SubscriptionReference) client.subscription(subscription) # sub-binding (dynamic, via SubscriptionReference) + client.pausable_subscription(subscription) # sub-binding (dynamic, via SubscriptionReference) client.notification() # sub-binding accessor ``` diff --git a/docs/references/service_discovery.md b/docs/references/service_discovery.md index 79c3704b..38dc5905 100644 --- a/docs/references/service_discovery.md +++ b/docs/references/service_discovery.md @@ -1,3 +1,9 @@ +--- +hide: + - path +comments: true +--- + !!! warning Before performing any operations on an ONVIF device, it is highly recommended to discover which services are available and supported by the device. @@ -19,16 +25,16 @@ By checking available services, your application can adapt its workflow and UI t ## How service discovery works in this library -!!! tip +!!! question "Behind the scene" The library handles service discovery automatically with intelligent fallback. You typically don't need to call discovery methods manually unless you need detailed capability information or want to refresh the service list after device configuration changes. The [`ONVIFClient`](../api/core/onvif_client.md) uses a **3-tier discovery approach** to maximize device compatibility: ### `GetServices` (Preferred) -Tries `GetServices` first for detailed service information. +Tries [`GetServices`](../api/services/device.md#onvif.services.devicemgmt.Device.GetServices) first for detailed service information. ### `GetCapabilities` (Fallback) -Falls back to `GetCapabilities` if `GetServices` is not supported by the device. +Falls back to [`GetCapabilities`](../api/services/device.md#onvif.services.devicemgmt.Device.GetCapabilities) if [`GetServices`](../api/services/device.md#onvif.services.devicemgmt.Device.GetServices) is not supported by the device. ### Default URLs (Final Fallback) Uses standard ONVIF URLs as last resort. @@ -39,7 +45,12 @@ You can check which service discovery method your ONVIF connection is using with ```python linenums="1" from onvif import ONVIFClient -client = ONVIFClient("192.168.1.17", 8000, "admin", "admin123") +client = ONVIFClient( + host="192.168.1.17", + port=8000, + username="admin", + password="password" +) # Check what discovery method was used if client.services: @@ -55,9 +66,9 @@ else: ## Why this approach? -`GetServices` provides the most accurate and detailed service information, but it's **optional** in the ONVIF specification. +[`GetServices`](../api/services/device.md#onvif.services.devicemgmt.Device.GetServices) provides the most accurate and detailed service information, but it's **optional** in the ONVIF specification. -`GetCapabilities` is **mandatory** for all ONVIF-compliant devices, ensuring broader compatibility. +[`GetCapabilities`](../api/services/device.md#onvif.services.devicemgmt.Device.GetCapabilities) is **mandatory** for all ONVIF-compliant devices, ensuring broader compatibility. **Default URLs** guarantee basic connectivity even with non-compliant devices. diff --git a/docs/references/supported_profiles.md b/docs/references/supported_profiles.md index fcbd148c..58f92f4d 100644 --- a/docs/references/supported_profiles.md +++ b/docs/references/supported_profiles.md @@ -1,3 +1,9 @@ +--- +hide: + - path +comments: true +--- + This library fully supports all major ONVIF Profiles listed below. Each profile represents a standardized set of features and use cases, ensuring interoperability between ONVIF-compliant devices and clients. You can use this library to integrate with devices and systems that implement any of these profiles. | Name | Specs | Main Features | Typical Use Case | Support | diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 65a5b465..6a152bb3 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -1,29 +1,54 @@ [data-md-color-scheme="default"] { + /* Background */ --md-default-bg-color: #ebebeb; - --md-primary-fg-color: #0000ff; + + /* Primary */ + --md-primary-fg-color: #003399; + --md-typeset-a-color: #003399; + + /* Accent */ + --md-accent-fg-color: #005fd3; + --md-accent-fg-color--transparent: rgba(0, 51, 153, 0.08); } [data-md-color-scheme="slate"] { - --md-primary-fg-color: #003399; + /* Background */ + --md-default-bg-color: #0a1224; + + /* Primary */ + --md-primary-fg-color: #002266; --md-typeset-a-color: #60a5fa; + + /* Accent */ + --md-accent-fg-color: #93c5fd; + --md-accent-fg-color--transparent: rgba(96, 165, 250, 0.12); +} + +/* Footer — Light */ +[data-md-color-scheme="default"] .md-footer { + background-color: #002266; } -[data-md-color-scheme="default"] .md-footer, [data-md-color-scheme="default"] .md-footer-meta { background-color: #003399; } -[data-md-color-scheme="slate"] .md-footer, +/* Footer — Dark */ +[data-md-color-scheme="slate"] .md-footer { + background-color: #030b1c; +} + [data-md-color-scheme="slate"] .md-footer-meta { - background-color: #020617; + background-color: #002266; } -.md-nav__source { - background-color: var(--md-primary-fg-color); +.md-footer-meta__inner { + padding-top: 0.5rem; + padding-bottom: 0.5rem; } -.md-typeset table td code { - white-space: nowrap; +.md-nav__source { + background-color: var(--md-primary-fg-color); } .md-nav__link[href$="/releases/"] { @@ -31,21 +56,25 @@ } .external-link-icon { - display: inline-block; + display: inline-flex; width: 0.8em; height: 0.8em; - margin-left: 0.2em; + margin-left: 0.15em; vertical-align: -0.05em; + align-items: center; + justify-content: center; + flex-shrink: 0; } .external-link-icon svg { + display: block; width: 100%; height: 100%; fill: currentColor; } .md-content__inner { - padding-bottom: 3rem; + padding-bottom: 2rem; } .md-source-file__fact { @@ -53,7 +82,7 @@ } .github-release { - margin-bottom: 3rem; + margin-bottom: 2rem; } .github-release__metadata { @@ -86,6 +115,10 @@ color: inherit; } +.md-typeset table td code { + white-space: nowrap; +} + .md-content__inner .md-typeset__table, .md-content__inner .md-typeset__table table { display: table !important; width: 100%; @@ -108,13 +141,13 @@ /* Thumb */ ::-webkit-scrollbar-thumb { - background: #0000ff; + background: #003399; border-radius: 4px; } /* Thumb hover */ ::-webkit-scrollbar-thumb:hover { - background: #003399; + background: #002266; } :root { @@ -164,17 +197,395 @@ display: block; padding: .1rem .4rem; color: #ebebeb; - font-weight: bold; - font-size: .8rem; - border: .05rem solid #ebebeb7a; - border-radius: .2rem; + font-weight: 600; + font-size: .75rem; + border: .05rem solid #ebebeb50; + border-radius: .3rem; content: "/"; } +[data-md-toggle=search]:not(:checked) ~ .md-header .md-search__form { + border-top-right-radius: 0.5rem !important; + border-bottom-left-radius: 0.5rem !important; + border-bottom-right-radius: 0.5rem !important; + border-top-left-radius: 0.5rem !important; +} + .md-tooltip2 { z-index: 4 !important; } .md-tooltip2__inner [id^="fn:"] { display: none !important; +} + +/* Align breadcrumb separators */ +.md-path__item { + display: inline-flex; + align-items: center; +} + +.md-path__link { + display: inline-flex; + align-items: center; +} + +.md-typeset .grid.cards .middle { + vertical-align: middle; +} + +.icon-link { + display: inline-flex; + align-items: center; + gap: 0.35em; +} + +/* TOC separators — desktop only */ +@media screen and (min-width: 76.25em) { + .md-nav--secondary .md-nav__list { + border-left: 2px solid var(--md-default-fg-color--lightest); + margin-left: 0.5rem; + padding-left: 0.75rem; + } + + .md-nav--secondary > .md-nav__list { + border-left: none; + margin-left: 0; + padding-left: 0; + } + + .md-nav--secondary .md-nav__link { + position: relative; + } + + .md-nav--secondary .md-nav__link::before { + content: ""; + position: absolute; + left: -0.6rem; + top: 50%; + width: 0.4rem; + border-top: 2px solid var(--md-default-fg-color--lightest); + } + + /* Remove separators from top-level TOC links */ + .md-nav--secondary > .md-nav__list > .md-nav__item > .md-nav__link::before { + display: none; + } +} + +/* TOC title icon */ +.md-nav--secondary .md-nav__title::before { + content: ""; + display: inline-block; + width: 1em; + height: 1em; + margin-right: 0.1rem; + vertical-align: -0.15em; + background-color: currentColor; + mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 -960 960 960'%3E%3Cpath fill='black' d='M360-200v-80h480v80H360Zm0-240v-80h480v80H360Zm0-240v-80h480v80H360ZM200-160q-33 0-56.5-23.5T120-240q0-33 23.5-56.5T200-320q33 0 56.5 23.5T280-240q0 33-23.5 56.5T200-160Zm0-240q-33 0-56.5-23.5T120-480q0-33 23.5-56.5T200-560q33 0 56.5 23.5T280-480q0 33-23.5 56.5T200-400Zm-56.5-263.5Q120-687 120-720t23.5-56.5Q167-800 200-800t56.5 23.5Q280-753 280-720t-23.5 56.5Q233-640 200-640t-56.5-23.5Z'/%3E%3C/svg%3E") center / contain no-repeat; + -webkit-mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 -960 960 960'%3E%3Cpath fill='black' d='M360-200v-80h480v80H360Zm0-240v-80h480v80H360Zm0-240v-80h480v80H360ZM200-160q-33 0-56.5-23.5T120-240q0-33 23.5-56.5T200-320q33 0 56.5 23.5T280-240q0 33-23.5 56.5T200-160Zm0-240q-33 0-56.5-23.5T120-480q0-33 23.5-56.5T200-560q33 0 56.5 23.5T280-480q0 33-23.5 56.5T200-400Zm-56.5-263.5Q120-687 120-720t23.5-56.5Q167-800 200-800t56.5 23.5Q280-753 280-720t-23.5 56.5Q233-640 200-640t-56.5-23.5Z'/%3E%3C/svg%3E") center / contain no-repeat; +} + +/* Rounded grid cards */ +.md-typeset .grid.cards > ul > li, +.md-typeset .grid.cards > ol > li, +.md-typeset .grid > .card { + border-radius: 0.5rem; + overflow: hidden; +} + +/* Rounded tables */ +.md-typeset__table table{ + border-top-right-radius: 0.5rem !important; + border-bottom-left-radius: 0.5rem !important; + border-bottom-right-radius: 0.5rem !important; + border-top-left-radius: 0.5rem !important; +} + +/* Rounded admonition */ +.admonition { + border-top-right-radius: 0.5rem !important; + border-bottom-left-radius: 0.5rem !important; + border-bottom-right-radius: 0.5rem !important; + border-top-left-radius: 0.5rem !important; +} + +.admonition-title { + border-top-right-radius: 0.5rem !important; + border-top-left-radius: 0.5rem !important; +} + +.md-typeset .admonition, +.md-typeset details { + border-width: 0; + border-left-width: 3px; +} + +/* Rounded collapsible admonition */ +.md-typeset details, +.md-typeset details:not([open]) > summary { + border-radius: 0.5rem !important; +} + +/* Rounded top corners when open */ +.md-typeset details[open] > summary { + border-top-right-radius: 0.5rem !important; + border-top-left-radius: 0.5rem !important; +} + +/* 404 page */ +@media screen and (min-width: 76.25em) { + body:has(.error-page) .md-sidebar { + display: none !important; + } + + body:has(.error-page) .md-content { + max-width: 100% !important; + margin-inline: 0 !important; + } + + body:has(.error-page) .md-content__inner { + margin-inline: 0 !important; + } +} + +.error-page { + display: flex; + min-height: 55vh; + align-items: center; + justify-content: flex-start; + text-align: left; +} + +.error-page__content { + width: 100%; + max-width: 30rem; +} + +.error-page__code { + margin: 0; + color: var(--md-typeset-a-color); + font-size: clamp(4rem, 16vw, 8rem); + font-weight: 800; + letter-spacing: -0.08em; + line-height: 1; +} + +.error-page h1 { + margin-top: 1.5rem; + margin-bottom: 1.5rem; + color: var(--md-default-fg-color); +} + +.error-page__description { + max-width: 30rem; + margin: 0 0 2rem; + color: var(--md-default-fg-color--light); + line-height: 1.7; +} + +.error-page__actions { + display: flex; + flex-wrap: wrap; + justify-content: flex-start; + gap: 0.5rem; +} + +.error-page__actions .md-button { + margin: 0; + border-radius: 0.5rem; + color: var(--md-typeset-a-color); +} + +.error-page__actions .md-button--primary { + background-color: var(--md-typeset-a-color); + border-color: var(--md-typeset-a-color); + color: var(--md-default-bg-color) !important; +} + +/* Grid cards — border color on hover */ +.md-typeset .grid.cards > ul > li, +.md-typeset .grid.cards > ul > li > hr { + transition: border-color 200ms ease; +} + +.md-typeset .grid.cards > ul > li:hover { + border-color: var(--md-accent-fg-color); +} + +/* Code content — border color on hover */ +.md-typeset .highlight .md-code__content { + border: 1px solid transparent; +} + +@media screen and (min-width: 76.25em) { + .md-typeset .highlight .md-code__content { + border-radius: 0.5rem; + } +} + +.md-typeset .highlight .md-code__content:hover { + border-color: var(--md-accent-fg-color); + transition: border-color 200ms ease; +} + +/* Navigation */ +.md-header .md-header__inner{ + padding-top: 0.2rem; + padding-bottom: 0.2rem; +} + +/* Edit and View tooltips */ +.md-content__button[data-tooltip] { + position: relative; +} + +.md-content__button[data-tooltip]::after { + content: attr(data-tooltip); + position: absolute; + top: calc(100% + 0.3rem); + left: 50%; + z-index: 100; + width: max-content; + max-width: 16rem; + padding: 0.3rem 0.5rem; + border-radius: 0.5rem; + background: var(--md-default-bg-color); + color: var(--md-default-fg-color); + box-shadow: var(--md-shadow-z2); + font-size: 0.5rem; + font-weight: 600; + line-height: 1.4; + white-space: normal; + pointer-events: none; + opacity: 0; + visibility: hidden; + transform: translate(-50%, -5px); + transition: + opacity 250ms ease, + transform 250ms ease, + visibility 250ms ease; +} + +.md-content__button[data-tooltip]:hover::after, +.md-content__button[data-tooltip]:focus-visible::after { + opacity: 1; + visibility: visible; + transform: translate(-50%, 0); +} + +.md-content__button svg { + width: 1.2rem; + height: 1.2rem; + vertical-align: middle; +} + +/* Back to top button */ +html { + scroll-behavior: smooth; +} + +.md-top { + z-index: 10; + top: auto !important; + bottom: 1.5rem !important; +} + +[data-md-color-scheme="default"] .md-top:hover, +[data-md-color-scheme="default"] .md-top:focus { + color: #F5F5F5; +} + +[data-md-color-scheme="slate"] .md-top:hover, +[data-md-color-scheme="slate"] .md-top:focus { + color: #030b1c; +} + +/* Flash section when scroll */ +.section-flash-overlay { + position: fixed; + z-index: 10; + pointer-events: none; + border: 1px solid transparent; + border-radius: 0.5rem; + box-sizing: border-box; +} + +@keyframes section-outline-flash { + 0%, + 100% { + border-color: transparent; + } + + 25%, + 75% { + border-color: var(--md-accent-fg-color); + } +} + +.section-flash-overlay.is-visible { + animation: section-outline-flash 0.6s ease-in-out; +} + +/* Tooltip */ +.md-tooltip2__inner { + border-radius: 0.5rem; +} + +.md-tooltip { + border-radius: 0.5rem; +} + +/* MDX Badge */ +.md-typeset .mdx-badge { + display: inline-flex; + align-items: stretch; + vertical-align: middle; + font-size: 0.85em; + line-height: 1; +} + +.md-typeset .mdx-badge--right { + float: right; + margin-left: 0.35em; +} + +.md-typeset .mdx-badge__icon, +.md-typeset .mdx-badge__text { + display: inline-flex; + align-items: center; + box-sizing: border-box; + padding: 0.25rem 0.35rem; +} + +.md-typeset .mdx-badge__icon { + justify-content: center; + color: var(--md-typeset-a-color); + background: var(--md-accent-fg-color--transparent); + border-start-start-radius: 0.25rem; + border-end-start-radius: 0.25rem; +} + +.md-typeset .mdx-badge__icon:last-child { + border-radius: 0.25rem; +} + +.md-typeset .mdx-badge__icon .twemoji { + display: inline-flex; + align-items: center; + justify-content: center; +} + +.md-typeset .mdx-badge__icon svg { + display: block; + width: 1em; + height: 1em; +} + +.md-typeset .mdx-badge__text { + color: var(--md-typeset-a-color); + border-start-end-radius: 0.25rem; + border-end-end-radius: 0.25rem; + box-shadow: 0 0 0 1px inset + var(--md-accent-fg-color--transparent); } \ No newline at end of file diff --git a/docs/utilities/helper_methods.md b/docs/utilities/helper_methods.md index 81c415e3..2d32bb23 100644 --- a/docs/utilities/helper_methods.md +++ b/docs/utilities/helper_methods.md @@ -1,3 +1,9 @@ +--- +hide: + - path +comments: true +--- + Every ONVIF service provides **four** essential helper methods to improve the development experience and make working with ONVIF operations more intuitive: !!! info @@ -5,7 +11,11 @@ Every ONVIF service provides **four** essential helper methods to improve the de ### `type(type_name)` -Creates and returns an instance of the specified ONVIF type for building complex request parameters (applied at [`>=v0.1.9`](../releases.md/#v0.1.9)). + + + + +Creates and returns an instance of the specified ONVIF type for building complex request parameters. **Parameters:** @@ -54,7 +64,10 @@ device.SetSystemDateAndTime(time_params) ### `operations()` -Lists all available operations for the current service (applied at [`>=v0.2.0`](../releases.md/#v0.2.0)). + + + +Lists all available operations for the current service. **Returns:** @@ -88,7 +101,10 @@ if 'ContinuousMove' in ptz.operations(): ### `desc(method_name)` -Provides comprehensive documentation and parameter information for any ONVIF operation (applied at [`>=v0.2.0`](../releases.md/#v0.2.0)). + + + +Provides comprehensive documentation and parameter information for any ONVIF operation. **Parameters:** @@ -134,7 +150,11 @@ for method in methods[:5]: # Show first 5 methods ### `to_dict(zeep_object)` -Converts a Zeep object (`zeep.objects`) (the raw result returned from ONVIF operations) into a native Python dictionary that is easy to serialize, inspect, and manipulate (applied at [`>=v0.2.9`](../releases.md/#v0.2.9)). + + + + +Converts a Zeep object (`zeep.objects`) (the raw result returned from ONVIF operations) into a native Python dictionary that is easy to serialize, inspect, and manipulate. **Parameters:** diff --git a/mkdocs.yml b/mkdocs.yml index c5c943fd..a417ae63 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,37 +1,68 @@ site_name: ONVIF Python -site_description: A modern Python library for ONVIF-compliant IP cameras and devices, providing a clean, typed API for discovery, device management, media, PTZ, and events. +site_description: >- + A modern Python library for ONVIF-compliant IP cameras and devices, providing a clean, + typed API for discovery, device management, media, PTZ, and events. site_url: https://nirsimetri.github.io/onvif-python/ repo_url: https://github.com/nirsimetri/onvif-python repo_name: nirsimetri/onvif-python +edit_uri: edit/dev/docs/ use_directory_urls: true theme: name: material + language: en custom_dir: docs/overrides logo: assets/nirsimetri-light.svg favicon: assets/nirsimetri-dark.svg icon: repo: fontawesome/brands/github + admonition: + example: material/code-tags + danger: material/skull + bug: material/flask-outline + note: material/book-open-variant + tip: material/source-pull + info: material/lightbulb + abstract: material/feature-search + warning: material/traffic-cone + question: material/telescope + success: material/check-circle + failure: material/cancel + edit: material/text-box-edit-outline + view: material/text-box-search-outline + top: material/transfer-up font: - text: Manrope - code: JetBrains Mono + text: Geist + code: Geist Mono features: + - content.action.edit + - content.action.view + - content.code.copy + - content.code.annotate + - content.tooltips + - content.footnote.tooltips + - navigation.path + - navigation.indexes - navigation.instant - navigation.instant.progress - navigation.instant.preview - navigation.sections - navigation.top - - content.code.copy + - navigation.tabs + - navigation.tabs.sticky + - navigation.footer + - navigation.prune + - search.highlight - search.suggest - - content.tooltips - - content.footnote.tooltips + - toc.follow + palette: - media: "(prefers-color-scheme: light)" scheme: default primary: custom accent: custom toggle: - icon: material/weather-night + icon: material/lightbulb-on-10 name: Switch to dark mode - media: "(prefers-color-scheme: dark)" @@ -39,106 +70,143 @@ theme: primary: custom accent: custom toggle: - icon: material/weather-sunny + icon: material/lightbulb-on-90 name: Switch to light mode nav: - - About: index.md - - Philosophy: philosophy.md - - Installation: installation.md - - Quick Start: quick_start.md - - Core: - - Client: core/onvif_client.md - - CLI: core/onvif_cli.md - - Discovery: core/onvif_discovery.md - - Utilities: - - Helper Methods: utilities/helper_methods.md + - Home: index.md + - Getting Started: + - Installation: installation.md + - Quickstart: quick_start.md + - Approach: approach.md + - Usage: + - Client: main/onvif_client.md + - CLI: main/onvif_cli.md + - Utilities: + - Helper Methods: utilities/helper_methods.md - References: - - ONVIF Profiles: references/supported_profiles.md + - references/index.md + - ONVIF Profiles: + - Supports: references/supported_profiles.md - ONVIF Services: - Coverage: references/implemented_services.md - - Service Discovery: references/service_discovery.md - - Service Bindings: references/service_bindings.md + - Discovery: references/service_discovery.md + - Bindings: references/service_bindings.md - API: + - api/index.md - Core: + - api/core/index.md - ONVIFClient: api/core/onvif_client.md - ONVIFOperator: api/core/onvif_operator.md - - ONVIFDiscovery: api/core/onvif_discovery.md - Exceptions: + - api/exceptions/index.md - ONVIFOperationException: api/exceptions/onvif_exception.md - Error Handlers: api/exceptions/onvif_error_handlers.md - Utilities: + - api/utilities/index.md + - ONVIFDiscovery: api/utilities/onvif_discovery.md - CacheMode: api/utilities/cache_mode.md - ONVIFWSDL: api/utilities/onvif_wsdl.md - ONVIFService: api/utilities/onvif_service.md - ZeepPatcher: api/utilities/zeep_patcher.md - Plugins: api/utilities/plugins.md - Services: + - api/services/index.md - Device: api/services/device.md - Events: - - Events: api/services/events.md - - PullPoint: api/services/pullpoint.md - - Notification: api/services/notification.md - - Subscription: api/services/subscription.md - - PausableSubscription: api/services/pausable_subscription.md + - api/services/events/index.md + - PullPoint: api/services/events/pullpoint.md + - Notification: api/services/events/notification.md + - Subscription: api/services/events/subscription.md + - PausableSubscription: api/services/events/pausable_subscription.md - Imaging: api/services/imaging.md - Media: api/services/media.md - Media2: api/services/media2.md - PTZ: api/services/ptz.md + - Provisioning: api/services/provisioning.md - DeviceIO: api/services/deviceio.md - Display: api/services/display.md + - Thermal: api/services/thermal.md - Analytics: - - Analytics: api/services/analytics.md - - RuleEngine: api/services/ruleengine.md + - api/services/analytics/index.md + - RuleEngine: api/services/analytics/ruleengine.md - AnalyticsDevice: api/services/analyticsdevice.md + - Receiver: api/services/receiver.md + - Recording: api/services/recording.md + - Search: api/services/search.md + - Replay: api/services/replay.md + - ActionEngine: api/services/actionengine.md + - Schedule: api/services/schedule.md - AccessControl: api/services/accesscontrol.md - DoorControl: api/services/doorcontrol.md - AccessRules: api/services/accessrules.md - - ActionEngine: api/services/actionengine.md - - AppManagement: api/services/appmgmt.md - AuthenticationBehavior: api/services/authenticationbehavior.md - Credential: api/services/credential.md - - Recording: api/services/recording.md - - Search: api/services/search.md - - Replay: api/services/replay.md - - Provisioning: api/services/provisioning.md - - Receiver: api/services/receiver.md - - Schedule: api/services/schedule.md - - Thermal: api/services/thermal.md - - Uplink: api/services/uplink.md - Security: - - AdvancedSecurity: api/services/advancedsecurity.md - - AuthorizationServer: api/services/authorizationserver.md - - Dot1x: api/services/dot1x.md - - JWT: api/services/jwt.md - - KeyStore: api/services/keystore.md - - MediaSigning: api/services/mediasigning.md - - TLSServer: api/services/tlsserver.md + - api/services/security/index.md + - AuthorizationServer: api/services/security/authorizationserver.md + - Dot1x: api/services/security/dot1x.md + - JWT: api/services/security/jwt.md + - Keystore: api/services/security/keystore.md + - MediaSigning: api/services/security/mediasigning.md + - TLSServer: api/services/security/tlsserver.md + - AppManagement: api/services/appmgmt.md + - Uplink: api/services/uplink.md - Project: - Contributing: project/contributing.md - Roadmap: project/roadmap.md - Used By: project/used_by.md - External: project/external.md - Legal: - - Legal Notice: legal/legal_notice.md + - Notice: legal/notice.md - License: legal/license.md - Releases: releases.md # It will be hidden because it serves as a placeholder. plugins: - search + - minify: + minify_html: true + minify_js: true + minify_css: true + js_files: + - javascripts/github-releases.js + - javascripts/external-links.js + - javascripts/section-flash.js + - javascripts/extra.js + css_files: + - stylesheets/extra.css + - git-revision-date-localized: + exclude: + - releases.md + type: timeago + enable_creation_date: true - git-authors: + exclude: + - releases.md show_contribution: true show_email_address: false sort_authors_by: contribution - mkdocstrings: handlers: python: + inventories: + - https://docs.python.org/3/objects.inv + - https://docs.python-zeep.org/en/master/objects.inv options: show_source: false + show_labels: true docstring_style: google show_root_full_path: false show_root_toc_entry: false + show_signature: true show_signature_annotations: true + separate_signature: true + signature_crossrefs: true + show_attribute_values: true + show_symbol_type_toc: true + show_symbol_type_heading: true + extensions: + - docs/hooks/griffe_extensions.py:DocstringShortcodes markdown_extensions: - abbr @@ -155,8 +223,12 @@ markdown_extensions: pygments_lang_class: true linenums_style: pymdownx-inline - pymdownx.emoji: + strict: true emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg + options: + custom_icons: + - docs/overrides/.icons - pymdownx.superfences - pymdownx.tasklist: custom_checkbox: true @@ -168,6 +240,30 @@ validation: extra: generator: false + social: + - icon: fontawesome/solid/globe + link: https://nirsimetri.com + name: Website + + - icon: fontawesome/brands/github + link: https://github.com/nirsimetri + name: GitHub + + - icon: fontawesome/brands/python + link: https://pypi.org/project/onvif-python/ + name: PyPI + + - icon: fontawesome/brands/x-twitter + link: https://x.com/nirsimetri + name: X + + - icon: fontawesome/brands/mastodon + link: https://fosstodon.org/@nirsimetri + name: Mastodon + + - icon: fontawesome/brands/linkedin + link: https://www.linkedin.com/company/nirsimetri-technologies + name: LinkedIn extra_css: - stylesheets/extra.css @@ -177,8 +273,12 @@ extra_javascript: - https://cdn.jsdelivr.net/npm/dompurify@3.4.15/dist/purify.min.js - javascripts/github-releases.js - javascripts/external-links.js + - javascripts/section-flash.js + - javascripts/extra.js hooks: - - docs/hooks.py + - docs/hooks/misc.py + - docs/hooks/shortcodes.py -copyright: Copyright © 2026  —  Nirsimetri Technologies® \ No newline at end of file +copyright: >- + © 2025 - 2026  
Nirsimetri Technologies® \ No newline at end of file diff --git a/onvif/client.py b/onvif/client.py index c88888b9..138632c2 100644 --- a/onvif/client.py +++ b/onvif/client.py @@ -1,3 +1,4 @@ +# pylint: disable=too-many-lines """High-level ONVIF client for interacting with ONVIF-compliant devices.""" from __future__ import annotations @@ -72,7 +73,7 @@ def service(func: Callable[P, R]) -> Callable[P, R]: ONVIF client service accessors. Args: - func: Service accessor method to wrap. + func (Callable): Service accessor method to wrap. Returns: Wrapped service accessor method. @@ -104,26 +105,32 @@ def wrapper(*args: P.args, **kwargs: P.kwargs) -> R: class ONVIFClient: - """High-level ONVIF client for interacting with ONVIF-compliant devices. + """ + + + High-level ONVIF client for interacting with ONVIF-compliant devices. This is the main class for interacting with ONVIF devices. It provides access to all ONVIF services including Device Management, Media, PTZ, Events, Analytics, and more. - The client automatically discovers available services on the device using `GetServices` - or `GetCapabilities`, and provides lazy initialization for service endpoints. + The client automatically discovers available services on the device using + [`GetServices`](../services/device.md#onvif.services.devicemgmt.Device.GetServices) or + [`GetCapabilities`](../services/device.md#onvif.services.devicemgmt.Device.GetCapabilities), + and provides lazy initialization for service endpoints. Attributes: - services (list): List of available services from `GetServices` response - capabilities (CompoundValue): Device capabilities from `GetCapabilities` response (fallback) - xml_plugin (XMLCapturePlugin): XML capture plugin for debugging (if `capture_xml=True`) + services (list | None): List of available services from `GetServices` response + capabilities (CompoundValue | None): Device capabilities from `GetCapabilities` + response (fallback) + xml_plugin (XMLCapturePlugin | None): XML capture plugin for debugging + (if `capture_xml=True`) wsdl_dir (str | None): Custom WSDL directory path (if provided) plugins (list[Plugin] | None): List of user-provided Zeep plugins (if any) !!! tip "Version History" - - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release) - - Added in [`>=v0.0.6`](/onvif-python/releases/#v0.0.6): `xml_plugin` - - Added in [`>=v0.1.0`](/onvif-python/releases/#v0.1.0): `wsdl_dir` - - Added in [`>=v0.4.3`](/onvif-python/releases/#v0.4.3): `plugins` + - Added in [`v0.0.6`](/onvif-python/releases/#v0.0.6): `xml_plugin` + - Added in [`v0.1.0`](/onvif-python/releases/#v0.1.0): `wsdl_dir` + - Added in [`v0.4.3`](/onvif-python/releases/#v0.4.3): `plugins` """ def __init__( @@ -157,15 +164,15 @@ def __init__( apply_patch (bool): Whether to apply ``xsd:any`` flattening patch capture_xml (bool): Whether to use XML capture plugin for debugging SOAP requests/responses wsdl_dir (str | None): Custom WSDL directory path for using external WSDL files instead of built-in ones - plugins (list[Plugin] | None): List of user-provided Zeep plugins (zeep.plugins) + plugins (list[Plugin] | None): List of user-provided Zeep plugins (`zeep.Plugin`) !!! tip "Version History" - - Added in [`>=v0.0.4`](/onvif-python/releases/#v0.0.4): `apply_patch` - - Added in [`>=v0.0.6`](/onvif-python/releases/#v0.0.6): `capture_xml` - - Added in [`>=v0.1.0`](/onvif-python/releases/#v0.1.0): `wsdl_dir` - - Added in [`>=v0.2.2`](/onvif-python/releases/#v0.2.2): `plugins` - - Added in [`>=v0.3.0`](/onvif-python/releases/#v0.3.0): `http_digest` - - Changed in [`>=v0.3.0`](/onvif-python/releases/#v0.3.0): `username` → `str | None`, + - Added in [`v0.0.4`](/onvif-python/releases/#v0.0.4): `apply_patch` + - Added in [`v0.0.6`](/onvif-python/releases/#v0.0.6): `capture_xml` + - Added in [`v0.1.0`](/onvif-python/releases/#v0.1.0): `wsdl_dir` + - Added in [`v0.2.2`](/onvif-python/releases/#v0.2.2): `plugins` + - Added in [`v0.3.0`](/onvif-python/releases/#v0.3.0): `http_digest` + - Changed in [`v0.3.0`](/onvif-python/releases/#v0.3.0): `username` → `str | None`, `password` → `str | None` """ logger.info("Initializing ONVIF client for %s:%d", host, port) @@ -484,7 +491,11 @@ def _configure_plugins( @service def devicemgmt(self) -> Device: - """Access the Device Management service.""" + """ + + + + Access the Device Management service.""" if self._devicemgmt is None: logger.debug("Initializing Device Management service") self._devicemgmt = Device(**self.common_args) @@ -552,7 +563,11 @@ def _get_subscription_service( @service def events(self) -> Events: - """Access the Events service.""" + """ + + + + Access the Events service.""" if self._events is None: logger.debug("Initializing Events service") self._events = Events( @@ -562,7 +577,11 @@ def events(self) -> Events: @service def pullpoint(self, SubscriptionRef) -> PullPoint: - """Access the PullPoint service.""" + """ + + + + Access the PullPoint service.""" logger.debug("Initializing PullPoint service") return self._get_subscription_service( SubscriptionRef, @@ -572,7 +591,11 @@ def pullpoint(self, SubscriptionRef) -> PullPoint: @service def notification(self) -> Notification: - """Access the Notification service.""" + """ + + + + Access the Notification service.""" if self._notification is None: logger.debug("Initializing Notification service") self._notification = Notification( @@ -582,7 +605,11 @@ def notification(self) -> Notification: @service def subscription(self, SubscriptionRef) -> Subscription: - """Access the Subscription service.""" + """ + + + + Access the Subscription service.""" logger.debug("Initializing Subscription service") return self._get_subscription_service( SubscriptionRef, @@ -593,10 +620,10 @@ def subscription(self, SubscriptionRef) -> Subscription: @service def pausable_subscription(self, SubscriptionRef) -> PausableSubscription: """ - Access the PausableSubscription service. + + - !!! tip "Version History" - - Available since [`>=v0.2.4`](/onvif-python/releases/#v0.2.4) + Access the PausableSubscription service. """ logger.debug("Initializing PausableSubscription service") return self._get_subscription_service( @@ -609,7 +636,11 @@ def pausable_subscription(self, SubscriptionRef) -> PausableSubscription: @service def imaging(self) -> Imaging: - """Access the Imaging service.""" + """ + + + + Access the Imaging service.""" if self._imaging is None: logger.debug("Initializing Imaging service") self._imaging = Imaging( @@ -621,7 +652,11 @@ def imaging(self) -> Imaging: @service def media(self) -> Media: - """Access the Media service.""" + """ + + + + Access the Media service.""" if self._media is None: logger.debug("Initializing Media service") self._media = Media( @@ -631,7 +666,11 @@ def media(self) -> Media: @service def media2(self) -> Media2: - """Access the Media2 service.""" + """ + + + + Access the Media2 service.""" if self._media2 is None: logger.debug("Initializing Media2 service") self._media2 = Media2( @@ -643,7 +682,11 @@ def media2(self) -> Media2: @service def ptz(self) -> PTZ: - """Access the PTZ service.""" + """ + + + + Access the PTZ service.""" if self._ptz is None: logger.debug("Initializing PTZ service") self._ptz = PTZ(xaddr=self._get_xaddr("ptz", "PTZ"), **self.common_args) @@ -653,7 +696,11 @@ def ptz(self) -> PTZ: @service def deviceio(self) -> DeviceIO: - """Access the DeviceIO service.""" + """ + + + + Access the DeviceIO service.""" if self._deviceio is None: logger.debug("Initializing DeviceIO service") self._deviceio = DeviceIO( @@ -665,7 +712,11 @@ def deviceio(self) -> DeviceIO: @service def display(self) -> Display: - """Access the Display service.""" + """ + + + + Access the Display service.""" if self._display is None: logger.debug("Initializing Display service") self._display = Display( @@ -677,7 +728,11 @@ def display(self) -> Display: @service def analytics(self) -> Analytics: - """Access the Analytics service.""" + """ + + + + Access the Analytics service.""" if self._analytics is None: logger.debug("Initializing Analytics service") self._analytics = Analytics( @@ -687,7 +742,11 @@ def analytics(self) -> Analytics: @service def ruleengine(self) -> RuleEngine: - """Access the RuleEngine service.""" + """ + + + + Access the RuleEngine service.""" if self._ruleengine is None: logger.debug("Initializing RuleEngine service") self._ruleengine = RuleEngine( @@ -697,7 +756,11 @@ def ruleengine(self) -> RuleEngine: @service def analyticsdevice(self) -> AnalyticsDevice: - """Access the AnalyticsDevice service.""" + """ + + + + Access the AnalyticsDevice service.""" if self._analyticsdevice is None: logger.debug("Initializing AnalyticsDevice service") self._analyticsdevice = AnalyticsDevice( @@ -710,7 +773,11 @@ def analyticsdevice(self) -> AnalyticsDevice: @service def accesscontrol(self) -> AccessControl: - """Access the AccessControl service.""" + """ + + + + Access the AccessControl service.""" if self._accesscontrol is None: logger.debug("Initializing AccessControl service") self._accesscontrol = AccessControl( @@ -721,7 +788,11 @@ def accesscontrol(self) -> AccessControl: @service def doorcontrol(self) -> DoorControl: - """Access the DoorControl service.""" + """ + + + + Access the DoorControl service.""" if self._doorcontrol is None: logger.debug("Initializing DoorControl service") self._doorcontrol = DoorControl( @@ -733,7 +804,11 @@ def doorcontrol(self) -> DoorControl: @service def accessrules(self) -> AccessRules: - """Access the AccessRules service.""" + """ + + + + Access the AccessRules service.""" if self._accessrules is None: logger.debug("Initializing AccessRules service") self._accessrules = AccessRules( @@ -745,7 +820,11 @@ def accessrules(self) -> AccessRules: @service def actionengine(self) -> ActionEngine: - """Access the ActionEngine service.""" + """ + + + + Access the ActionEngine service.""" if self._actionengine is None: logger.debug("Initializing ActionEngine service") self._actionengine = ActionEngine( @@ -758,7 +837,11 @@ def actionengine(self) -> ActionEngine: @service def appmanagement(self) -> AppManagement: - """Access the AppManagement service.""" + """ + + + + Access the AppManagement service.""" if self._appmanagement is None: logger.debug("Initializing AppManagement service") self._appmanagement = AppManagement( @@ -771,7 +854,11 @@ def appmanagement(self) -> AppManagement: @service def authenticationbehavior(self) -> AuthenticationBehavior: - """Access the AuthenticationBehavior service.""" + """ + + + + Access the AuthenticationBehavior service.""" if self._authenticationbehavior is None: logger.debug("Initializing AuthenticationBehavior service") self._authenticationbehavior = AuthenticationBehavior( @@ -786,7 +873,11 @@ def authenticationbehavior(self) -> AuthenticationBehavior: @service def credential(self) -> Credential: - """Access the Credential service.""" + """ + + + + Access the Credential service.""" if self._credential is None: logger.debug("Initializing Credential service") self._credential = Credential( @@ -799,7 +890,11 @@ def credential(self) -> Credential: @service def recording(self) -> Recording: - """Access the Recording service.""" + """ + + + + Access the Recording service.""" if self._recording is None: logger.debug("Initializing Recording service") self._recording = Recording( @@ -812,7 +907,11 @@ def recording(self) -> Recording: @service def replay(self) -> Replay: - """Access the Replay service.""" + """ + + + + Access the Replay service.""" if self._replay is None: logger.debug("Initializing Replay service") self._replay = Replay( @@ -825,7 +924,11 @@ def replay(self) -> Replay: @service def provisioning(self) -> Provisioning: - """Access the Provisioning service.""" + """ + + + + Access the Provisioning service.""" if self._provisioning is None: logger.debug("Initializing Provisioning service") self._provisioning = Provisioning( @@ -838,7 +941,11 @@ def provisioning(self) -> Provisioning: @service def receiver(self) -> Receiver: - """Access the Receiver service.""" + """ + + + + Access the Receiver service.""" if self._receiver is None: logger.debug("Initializing Receiver service") self._receiver = Receiver( @@ -851,7 +958,11 @@ def receiver(self) -> Receiver: @service def schedule(self) -> Schedule: - """Access the Schedule service.""" + """ + + + + Access the Schedule service.""" if self._schedule is None: logger.debug("Initializing Schedule service") self._schedule = Schedule( @@ -864,7 +975,11 @@ def schedule(self) -> Schedule: @service def search(self) -> Search: - """Access the Search service.""" + """ + + + + Access the Search service.""" if self._search is None: logger.debug("Initializing Search service") self._search = Search( @@ -877,7 +992,11 @@ def search(self) -> Search: @service def thermal(self) -> Thermal: - """Access the Thermal service.""" + """ + + + + Access the Thermal service.""" if self._thermal is None: logger.debug("Initializing Thermal service") self._thermal = Thermal( @@ -890,7 +1009,11 @@ def thermal(self) -> Thermal: @service def uplink(self) -> Uplink: - """Access the Uplink service.""" + """ + + + + Access the Uplink service.""" if self._uplink is None: logger.debug("Initializing Uplink service") self._uplink = Uplink( @@ -903,7 +1026,11 @@ def uplink(self) -> Uplink: @service def security(self) -> AdvancedSecurity: - """Access the AdvancedSecurity service.""" + """ + + + + Access the AdvancedSecurity service.""" if self._security is None: logger.debug("Initializing Security service") self._security = AdvancedSecurity( @@ -914,7 +1041,11 @@ def security(self) -> AdvancedSecurity: @service def jwt(self) -> JWT: - """Access the JWT service.""" + """ + + + + Access the JWT service.""" if self._jwt is None: logger.debug("Initializing JWT service") self._jwt = JWT( @@ -924,7 +1055,11 @@ def jwt(self) -> JWT: @service def keystore(self) -> Keystore: - """Access the Keystore service.""" + """ + + + + Access the Keystore service.""" if self._keystore is None: logger.debug("Initializing Keystore service") self._keystore = Keystore( @@ -934,7 +1069,11 @@ def keystore(self) -> Keystore: @service def tlsserver(self) -> TLSServer: - """Access the TLSServer service.""" + """ + + + + Access the TLSServer service.""" if self._tlsserver is None: logger.debug("Initializing TLSServer service") self._tlsserver = TLSServer( @@ -944,7 +1083,11 @@ def tlsserver(self) -> TLSServer: @service def dot1x(self) -> Dot1X: - """Access the Dot1X service.""" + """ + + + + Access the Dot1X service.""" if self._dot1x is None: logger.debug("Initializing Dot1X service") self._dot1x = Dot1X( @@ -954,7 +1097,11 @@ def dot1x(self) -> Dot1X: @service def authorizationserver(self) -> AuthorizationServer: - """Access the AuthorizationServer service.""" + """ + + + + Access the AuthorizationServer service.""" if self._authorizationserver is None: logger.debug("Initializing AuthorizationServer service") self._authorizationserver = AuthorizationServer( @@ -965,7 +1112,11 @@ def authorizationserver(self) -> AuthorizationServer: @service def mediasigning(self) -> MediaSigning: - """Access the MediaSigning service.""" + """ + + + + Access the MediaSigning service.""" if self._mediasigning is None: logger.debug("Initializing MediaSigning service") self._mediasigning = MediaSigning( diff --git a/onvif/operator.py b/onvif/operator.py index 06fd808c..6005578e 100644 --- a/onvif/operator.py +++ b/onvif/operator.py @@ -27,7 +27,11 @@ class CacheMode(Enum): - """WSDL caching strategies for ONVIF client performance optimization. + """ + + + + WSDL caching strategies for ONVIF client performance optimization. Different caching modes provide trade-offs between performance, memory usage, and disk storage. Choose based on the application's requirements. @@ -38,8 +42,7 @@ class CacheMode(Enum): DB (Literal['db']): Persistent SQLite caching across process restarts. !!! tip "Version History" - - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release) - - Removed in [`>=v0.4.0`](/onvif-python/releases/#v0.4.0): `CacheMode.ALL` + - Removed in [`v0.4.0`](/onvif-python/releases/#v0.4.0): `CacheMode.ALL` """ NONE = "none" @@ -52,7 +55,7 @@ class CacheMode(Enum): :material-alert-circle:{ .danger } WSDL/XSD documents are fetched without caching - !!! danger "Use case" + !!! bug "Use case" Debugging, testing, and situations where fresh WSDL/XSD documents are required. """ @@ -69,7 +72,7 @@ class CacheMode(Enum): :material-alert-circle:{ .danger } Cache is lost when the process exits - !!! danger "Use case" + !!! bug "Use case" Long-running applications, temporary sessions, and applications where persistent cache storage is not required. """ @@ -86,14 +89,18 @@ class CacheMode(Enum): :material-alert-circle:{ .danger } Requires disk I/O and a writable cache directory - !!! danger "Use case" + !!! bug "Use case" Production applications, CLI tools, and environments where WSDL/XSD caching should persist across restarts. """ class ONVIFOperator: - """Low-level ONVIF service operator using Zeep SOAP client. + """ + + + + Low-level ONVIF service operator using Zeep SOAP client. This class handles the actual SOAP communication with ONVIF devices. It manages WSDL loading, service binding, authentication, caching, and error handling. @@ -120,7 +127,6 @@ class ONVIFOperator: service_name (str): Name of the ONVIF service (e.g., "Device", "Media") !!! tip "Version History" - - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release) - No version tracking for attribute changes because this class is used internally """ @@ -267,15 +273,16 @@ def _create_wsse( ) def call(self, method: str, *args, **kwargs) -> Any: - """Call an ONVIF service operation. + """ + + + + Call an ONVIF service operation. This method invokes a SOAP operation on the ONVIF device service and handles errors gracefully. It automatically flattens `xsd:any` fields in the response when `apply_patch` is enabled. - !!! tip "Version History" - - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release) - Args: method (str): Name of the ONVIF operation to call (e.g., "GetDeviceInformation") *args (Any): Positional arguments to pass to the operation @@ -315,7 +322,11 @@ def legacy_call( *args, **kwargs, ) -> Any: - """Call a legacy ONVIF operation using the current WSDL definition. + """ + + + + Call a legacy ONVIF operation using the current WSDL definition. This provides compatibility with devices which implemented an older operation name that was subsequently renamed in the ONVIF WSDL. @@ -325,9 +336,6 @@ def legacy_call( and response definitions while overriding the operation name and SOAP action. - !!! tip "Version History" - - Available since [`>=v0.4.3`](/onvif-python/releases/#v0.4.3) - Args: legacy_method: Name of the legacy ONVIF operation current_method: Name of the operation defined by the current WSDL @@ -401,14 +409,15 @@ def legacy_call( ) from e def create_type(self, type_name: str) -> Any: - """Create a type instance from WSDL schema for the given type name. + """ + + + + Create a type instance from WSDL schema for the given type name. Recursively initializes nested complex types so that fields like TimeZone, DateTime, Date, and Time are properly instantiated as objects rather than None. - !!! tip "Version History" - - Available since [`>=v0.1.9`](/onvif-python/releases/#v0.1.9) - Args: type_name (str): Name of the type to create (e.g., 'SetHostname', 'SetIPAddressFilter') diff --git a/onvif/services/accesscontrol.py b/onvif/services/accesscontrol.py index 4ff5cd72..0733a444 100644 --- a/onvif/services/accesscontrol.py +++ b/onvif/services/accesscontrol.py @@ -6,11 +6,15 @@ class AccessControl(ONVIFService): - """AccessControl service client. + """ + + + + AccessControl service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.3 (May 2013) | + | **First introduced** | ONVIF 2.3 (May 2013) | | **Binding name** | `PACSBinding` (`ver10/pacs/accesscontrol.wsdl`) | | **Operations** | [accesscontrol.wsdl](https://www.onvif.org/ver10/pacs/accesscontrol.wsdl) | | **Spec** | [AccessControl](https://www.onvif.org/specs/srv/access/ONVIF-AccessControl-Service-Spec.pdf) | diff --git a/onvif/services/accessrules.py b/onvif/services/accessrules.py index 00f2a6c9..f257228f 100644 --- a/onvif/services/accessrules.py +++ b/onvif/services/accessrules.py @@ -6,11 +6,15 @@ class AccessRules(ONVIFService): - """AccessRules service client. + """ + + + + AccessRules service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.6 (June 2015) | + | **First introduced** | ONVIF 2.6 (June 2015) | | **Binding name** | `AccessRulesBinding` (`ver10/accessrules/wsdl/accessrules.wsdl`) | | **Operations** | [accessrules.wsdl](https://www.onvif.org/ver10/accessrules/wsdl/accessrules.wsdl) | | **Spec** | [AccessRules](https://www.onvif.org/specs/srv/access/ONVIF-AccessRules-Service-Spec.pdf) | diff --git a/onvif/services/actionengine.py b/onvif/services/actionengine.py index e5d9da3f..8bc60c30 100644 --- a/onvif/services/actionengine.py +++ b/onvif/services/actionengine.py @@ -6,11 +6,15 @@ class ActionEngine(ONVIFService): - """ActionEngine service client. + """ + + + + ActionEngine service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.2 (September 2012) | + | **First introduced** | ONVIF 2.2 (September 2012) | | **Binding name** | `ActionEngineBinding` (`ver10/actionengine.wsdl`) | | **Operations** | [actionengine.wsdl](https://www.onvif.org/ver10/actionengine.wsdl) | | **Spec** | [ActionEngine](https://www.onvif.org/specs/srv/act/ONVIF-ActionEngine-Service-Spec.pdf) | diff --git a/onvif/services/analytics/analytics.py b/onvif/services/analytics/analytics.py index 6253bbec..c545aaaa 100644 --- a/onvif/services/analytics/analytics.py +++ b/onvif/services/analytics/analytics.py @@ -6,11 +6,16 @@ class Analytics(ONVIFService): - """Analytics service client. + """ + + + + + Analytics service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.41 (December 2013) | + | **First introduced** | ONVIF 2.4 (August 2013) | | **Binding name** | `AnalyticsEngineBinding` (`ver20/analytics/wsdl/analytics.wsdl`) | | **Operations** | [analytics.wsdl](https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl) | | **Spec** | [Analytics](https://www.onvif.org/specs/srv/analytics/ONVIF-Analytics-Service-Spec.pdf) | diff --git a/onvif/services/analytics/ruleengine.py b/onvif/services/analytics/ruleengine.py index 3e44223a..9090a7ae 100644 --- a/onvif/services/analytics/ruleengine.py +++ b/onvif/services/analytics/ruleengine.py @@ -6,11 +6,15 @@ class RuleEngine(ONVIFService): - """Analytics (RuleEngine) service client. + """ + + + + Analytics (RuleEngine) service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.41 (December 2013) | + | **First introduced** | ONVIF 2.4 (August 2013) | | **Binding name** | `RuleEngineBinding` (`ver20/analytics/wsdl/analytics.wsdl`) | | **Operations** | [analytics.wsdl](https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl) | | **Spec** | [Analytics](https://www.onvif.org/specs/srv/analytics/ONVIF-Analytics-Service-Spec.pdf) | diff --git a/onvif/services/analyticsdevice.py b/onvif/services/analyticsdevice.py index afb7db03..3d2f8a99 100644 --- a/onvif/services/analyticsdevice.py +++ b/onvif/services/analyticsdevice.py @@ -7,8 +7,12 @@ class AnalyticsDevice(ONVIFService): # pylint: disable=line-too-long - """The AnalyticsDevice service (AnalyticsDeviceBinding) aka 'Video Analytics Device' - has been marked as obsolete since ONVIF Release 18.12. + """ + + + + The AnalyticsDevice service (AnalyticsDeviceBinding) aka 'Video Analytics Device' + has been marked as obsolete since ONVIF 18.12. Its functionality has largely been merged into the Analytics service and, in some cases Media/Media2. @@ -22,8 +26,8 @@ class AnalyticsDevice(ONVIFService): | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.1 (June 2011), split from Core 2.0 | - | **Deprecated** | ONVIF Release 18.12 (December 2018) | + | **First introduced** | ONVIF 2.0 (November 2010) | + | **Deprecated** | ONVIF 18.12 (December 2018) | | **Binding name** | `AnalyticsDeviceBinding` (`ver10/analyticsdevice.wsdl`) | | **Successor** | `Analytics` Service (`ver20/analytics/wsdl/analytics.wsdl`) | | **Operations** | [analyticsdevice.wsdl](https://www.onvif.org/ver10/analyticsdevice.wsdl) | diff --git a/onvif/services/appmgmt.py b/onvif/services/appmgmt.py index b922baf2..53a040c3 100644 --- a/onvif/services/appmgmt.py +++ b/onvif/services/appmgmt.py @@ -6,11 +6,15 @@ class AppManagement(ONVIFService): - """AppManagement service client. + """ + + + + AppManagement service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 19.12 (December 2019) | + | **First introduced** | ONVIF 19.12 (December 2019) | | **Binding name** | `AppManagementBinding` (`ver10/appmgmt/wsdl/appmgmt.wsdl`) | | **Operations** | [appmgmt.wsdl](https://www.onvif.org/ver10/appmgmt/wsdl/appmgmt.wsdl) | | **Spec** | [AppMgmt](https://www.onvif.org/specs/srv/appmgmt/ONVIF-ApplicationManagement-Service-Spec.pdf) | diff --git a/onvif/services/authenticationbehavior.py b/onvif/services/authenticationbehavior.py index 4bcef227..bc41da76 100644 --- a/onvif/services/authenticationbehavior.py +++ b/onvif/services/authenticationbehavior.py @@ -7,11 +7,15 @@ class AuthenticationBehavior(ONVIFService): # pylint: disable=line-too-long - """AuthenticationBehavior service client. + """ + + + + AuthenticationBehavior service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 18.06 (June 2018) | + | **First introduced** | ONVIF 18.06 (June 2018) | | **Binding name** | `AuthenticationBehaviorBinding` (`ver10/authenticationbehavior/wsdl/authenticationbehavior.wsdl`) | | **Operations** | [authenticationbehavior.wsdl](https://www.onvif.org/ver10/authenticationbehavior/wsdl/authenticationbehavior.wsdl) | | **Spec** | [AuthenticationBehavior](https://www.onvif.org/specs/srv/access/ONVIF-AuthenticationBehavior-Service-Spec.pdf) | diff --git a/onvif/services/credential.py b/onvif/services/credential.py index 051adbe8..5613b570 100644 --- a/onvif/services/credential.py +++ b/onvif/services/credential.py @@ -6,11 +6,15 @@ class Credential(ONVIFService): - """Credential service client. + """ + + + + Credential service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.6 (June 2015) | + | **First introduced** | ONVIF 2.6 (June 2015) | | **Binding name** | `CredentialBinding` (`ver10/credential/wsdl/credential.wsdl`) | | **Operations** | [credential.wsdl](https://www.onvif.org/ver10/credential/wsdl/credential.wsdl) | | **Spec** | [Credential](https://www.onvif.org/specs/srv/access/ONVIF-Credential-Service-Spec.pdf) | diff --git a/onvif/services/deviceio.py b/onvif/services/deviceio.py index ef8572f6..82774f92 100644 --- a/onvif/services/deviceio.py +++ b/onvif/services/deviceio.py @@ -6,11 +6,15 @@ class DeviceIO(ONVIFService): - """DeviceIO service client. + """ + + + + DeviceIO service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | + | **First introduced** | ONVIF 2.0 (November 2010) | | **Binding name** | `DeviceIOBinding` (`ver10/deviceio.wsdl`) | | **Operations** | [deviceio.wsdl](https://www.onvif.org/ver10/deviceio.wsdl) | | **Spec** | [DeviceIO](https://www.onvif.org/specs/srv/io/ONVIF-DeviceIo-Service-Spec.pdf) | diff --git a/onvif/services/devicemgmt.py b/onvif/services/devicemgmt.py index f344f27c..70fc7e8f 100644 --- a/onvif/services/devicemgmt.py +++ b/onvif/services/devicemgmt.py @@ -6,11 +6,16 @@ class Device(ONVIFService): - """Device service client. + """ + + + + + Device service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Core | + | **First introduced** | ONVIF 1.0 (November 2008) | | **Binding name** | `DeviceBinding` (`ver10/device/wsdl/devicemgmt.wsdl`) | | **Operations** | [devicemgmt.wsdl](https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl) | | **Spec** | [Core](https://www.onvif.org/specs/core/ONVIF-Core-Specification.pdf) | @@ -65,7 +70,7 @@ def SendAuxiliaryCommand(self, AuxiliaryCommand): - tt:Washer|On - Request to start the washer. - tt:Washer|Off - Request to stop the washer. - tt:WashingProcedure|On - Request to start the washing procedure. - - tt: WashingProcedure |Off - Request to stop the washing procedure. + - tt:WashingProcedure|Off - Request to stop the washing procedure. - tt:IRLamp|On - Request to turn ON an IR illuminator attached to the unit. - tt:IRLamp|Off - Request to turn OFF an IR illuminator attached to the unit. - tt:IRLamp|Auto - Request to configure an IR illuminator attached to the unit @@ -307,32 +312,32 @@ def SetRemoteUser(self, RemoteUser=None): return self.operator.call("SetRemoteUser", RemoteUser=RemoteUser) def GetUserRoles(self, UserRole=None): - """This operation returns the editable user levels configured in the device. + """ + + + This operation returns the editable user levels configured in the device. Whenever an editable user level is passed in the request, information only about that level is returned. - - !!! tip "Version History" - - Available since [`>=v0.2.7`](/onvif-python/releases/#v0.2.7) """ return self.operator.call("GetUserRoles", UserRole=UserRole) def SetUserRole(self, UserRole): - """This operation configures an editable user level in the device. + """ + + + This operation configures an editable user level in the device. If the level passed in UserRole already exists in the device, its configuration is overwritten. Otherwise, a new editable user level is created. - - !!! tip "Version History" - - Available since [`>=v0.2.7`](/onvif-python/releases/#v0.2.7) """ return self.operator.call("SetUserRole", UserRole=UserRole) def DeleteUserRole(self, UserRole): - """This operation deletes an editable user level in the device. + """ + - !!! tip "Version History" - - Available since [`>=v0.2.7`](/onvif-python/releases/#v0.2.7) + This operation deletes an editable user level in the device. """ return self.operator.call("DeleteUserRole", UserRole=UserRole) @@ -890,7 +895,10 @@ def StartFirmwareUpgrade(self): return self.operator.call("StartFirmwareUpgrade") def UpgradeFirmware(self, Version): - """This operation initiates a firmware upgrade using between the device and the + """ + + + This operation initiates a firmware upgrade using between the device and the MCS, without further actions from the client. Cloud firmware upgrade may be achieved using the following steps: @@ -906,9 +914,6 @@ def UpgradeFirmware(self, Version): as all the parameters of the Uplink and Security service unchanged, so that it can connect to the cloud. Additionally a firmware upgrade shall not change user credentials. - - !!! tip "Version History" - - Available since [`>=v0.2.6`](/onvif-python/releases/#v0.2.6) """ return self.operator.call("UpgradeFirmware", Version=Version) diff --git a/onvif/services/display.py b/onvif/services/display.py index 22d644cd..1abfe5c7 100644 --- a/onvif/services/display.py +++ b/onvif/services/display.py @@ -6,11 +6,15 @@ class Display(ONVIFService): - """Display service client. + """ + + + + Display service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | + | **First introduced** | ONVIF 2.0 (November 2010) | | **Binding name** | `DisplayBinding` (`ver10/display.wsdl`) | | **Operations** | [display.wsdl](https://www.onvif.org/ver10/display.wsdl) | | **Spec** | [Display](https://www.onvif.org/specs/srv/disp/ONVIF-Display-Service-Spec.pdf) | diff --git a/onvif/services/doorcontrol.py b/onvif/services/doorcontrol.py index 3f13af43..f9ee0813 100644 --- a/onvif/services/doorcontrol.py +++ b/onvif/services/doorcontrol.py @@ -6,11 +6,15 @@ class DoorControl(ONVIFService): - """DoorControl service client. + """ + + + + DoorControl service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.3 (May 2013) | + | **First introduced** | ONVIF 2.3 (May 2013) | | **Binding name** | `DoorControlBinding` (`ver10/pacs/doorcontrol.wsdl`) | | **Operations** | [doorcontrol.wsdl](https://www.onvif.org/ver10/pacs/doorcontrol.wsdl) | | **Spec** | [DoorControl](https://www.onvif.org/specs/srv/door/ONVIF-DoorControl-Service-Spec.pdf) | diff --git a/onvif/services/events/events.py b/onvif/services/events/events.py index 4415a9c2..a6f5594f 100644 --- a/onvif/services/events/events.py +++ b/onvif/services/events/events.py @@ -6,11 +6,16 @@ class Events(ONVIFService): - """Events service client. + """ + + + + + Events service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Core | + | **First introduced** | ONVIF 1.0 (November 2008) | | **Binding name** | `EventBinding` (`ver10/events/wsdl/event-vs.wsdl`) | | **Operations** | [event-vs.wsdl](https://www.onvif.org/ver10/events/wsdl/event-vs.wsdl) | | **Spec** | [Core](https://www.onvif.org/specs/core/ONVIF-Core-Specification.pdf) | diff --git a/onvif/services/events/notification.py b/onvif/services/events/notification.py index 8e185d81..8e033ac8 100644 --- a/onvif/services/events/notification.py +++ b/onvif/services/events/notification.py @@ -6,7 +6,11 @@ class Notification(ONVIFService): - """WS-BaseNotification NotificationProducer service client. + """ + + + + WS-BaseNotification NotificationProducer service client. This service provides access to the NotificationProducer interface used by ONVIF devices for push-based event notification subscriptions. diff --git a/onvif/services/events/pausable_subscription.py b/onvif/services/events/pausable_subscription.py index 94ae1275..f000ae53 100644 --- a/onvif/services/events/pausable_subscription.py +++ b/onvif/services/events/pausable_subscription.py @@ -6,7 +6,11 @@ class PausableSubscription(ONVIFService): - """WS-BaseNotification PausableSubscriptionManager service client. + """ + + + + WS-BaseNotification PausableSubscriptionManager service client. This interface extends the Base Subscription Manager with operations for temporarily pausing and resuming notification delivery. @@ -19,9 +23,6 @@ class PausableSubscription(ONVIFService): | **See** | ONVIF Core Spec, OASIS WS-BaseNotification Spec | | **Binding name** | `PausableSubscriptionManagerBinding` (`ver10/events/wsdl/event-vs.wsdl`) | | **Spec** | [PausableSubscription](https://docs.oasis-open.org/wsn/wsn-ws_base_notification-1.3-spec-os.htm#_Toc133735641) | - - !!! tip "Version History" - - Available since [`>=v0.2.4`](/onvif-python/releases/#v0.2.4) """ def __init__(self, xaddr=None, **kwargs): diff --git a/onvif/services/events/pullpoint.py b/onvif/services/events/pullpoint.py index 4ad140e5..d4243959 100644 --- a/onvif/services/events/pullpoint.py +++ b/onvif/services/events/pullpoint.py @@ -6,11 +6,15 @@ class PullPoint(ONVIFService): - """Events (PullPoint) service client. + """ + + + + Events (PullPoint) service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Core | + | **First introduced** | ONVIF 1.0 (November 2008) | | **Binding name** | `PullPointSubscriptionBinding` (`ver10/events/wsdl/event-vs.wsdl`) | | **Operations** | [event-vs.wsdl](https://www.onvif.org/ver10/events/wsdl/event-vs.wsdl) | | **Spec** | [Core](https://www.onvif.org/specs/core/ONVIF-Core-Specification.pdf) | diff --git a/onvif/services/events/subscription.py b/onvif/services/events/subscription.py index 46a68dd3..2104a5e3 100644 --- a/onvif/services/events/subscription.py +++ b/onvif/services/events/subscription.py @@ -6,7 +6,11 @@ class Subscription(ONVIFService): - """WS-BaseNotification SubscriptionManager service client. + """ + + + + WS-BaseNotification SubscriptionManager service client. This interface manages the lifecycle of a notification subscription created through the WS-BaseNotification NotificationProducer interface. diff --git a/onvif/services/imaging.py b/onvif/services/imaging.py index 08de4df5..cf686ff9 100644 --- a/onvif/services/imaging.py +++ b/onvif/services/imaging.py @@ -6,11 +6,16 @@ class Imaging(ONVIFService): - """Imaging service client. + """ + + + + + Imaging service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | + | **First introduced** | ONVIF 1.0 (November 2008) | | **Binding name** | `ImagingBinding` (`ver20/imaging/wsdl/imaging.wsdl`) | | **Operations** | [imaging.wsdl](https://www.onvif.org/ver20/imaging/wsdl/imaging.wsdl) | | **Spec** | [Imaging](https://www.onvif.org/specs/srv/img/ONVIF-Imaging-Service-Spec.pdf) | diff --git a/onvif/services/media.py b/onvif/services/media.py index 1c6a970e..29f8ed5d 100644 --- a/onvif/services/media.py +++ b/onvif/services/media.py @@ -6,11 +6,16 @@ class Media(ONVIFService): - """Media service client. + """ + + + + + Media service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | + | **First introduced** | ONVIF 1.0 (November 2008) | | **Binding name** | `MediaBinding` (`ver10/media/wsdl/media.wsdl`) | | **Operations** | [media.wsdl](https://www.onvif.org/ver10/media/wsdl/media.wsdl) | | **Spec** | [Media](https://www.onvif.org/specs/srv/media/ONVIF-Media-Service-Spec.pdf) | diff --git a/onvif/services/media2.py b/onvif/services/media2.py index 77ee28e5..fa71de16 100644 --- a/onvif/services/media2.py +++ b/onvif/services/media2.py @@ -6,11 +6,15 @@ class Media2(ONVIFService): - """Media2 service client. + """ + + + + Media2 service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.61 (December 2015) | + | **First introduced** | ONVIF 2.6.1 (December 2015) | | **Binding name** | `Media2Binding` (`ver20/media/wsdl/media.wsdl`) | | **Operations** | [media.wsdl](https://www.onvif.org/ver20/media/wsdl/media.wsdl) | | **Spec** | [Media2](https://www.onvif.org/specs/srv/media/ONVIF-Media2-Service-Spec.pdf) | @@ -304,10 +308,10 @@ def SetEQPreset(self, Configuration): ) def SetEQPresetConfiguration(self, Configuration): - """This command is to configure Audio EQPreset. + """ + - !!! tip "Version History" - - Available since [`>=v0.4.3`](/onvif-python/releases/#v0.4.3) + This command is to configure Audio EQPreset. """ return self.operator.call( "SetEQPresetConfiguration", Configuration=Configuration @@ -653,12 +657,12 @@ def PlayAudioClip(self, Token, Play, AudioOutputToken=None, RepeatCycles=None): ) def AddTTSAudioClip(self, Configuration, TTSConfiguration, Token=None): - """This operation sends a text and its configuration to device that supports TTS + """ + + + This operation sends a text and its configuration to device that supports TTS function, so that device could convert the text into an audio clip and play it according to audio clip Configuration and TTS Configuration. - - !!! tip "Version History" - - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) """ return self.operator.call( "AddTTSAudioClip", @@ -673,11 +677,11 @@ def GetPlayingAudioClips(self): return self.operator.call("GetPlayingAudioClips") def GetMulticastAudioDecoderConfigurationOptions(self, ConfigurationToken=None): - """This operation gets the available options for the MulticastAudioDecoder - configuration. + """ + - !!! tip "Version History" - - Available since [`>=v0.2.6`](/onvif-python/releases/#v0.2.6) + This operation gets the available options for the MulticastAudioDecoder + configuration. """ return self.operator.call( "GetMulticastAudioDecoderConfigurationOptions", @@ -685,10 +689,10 @@ def GetMulticastAudioDecoderConfigurationOptions(self, ConfigurationToken=None): ) def GetMulticastAudioDecoderConfigurations(self, ConfigurationToken=None): - """This operation gets the list of multicast audio decoder configurations. + """ + - !!! tip "Version History" - - Available since [`>=v0.2.6`](/onvif-python/releases/#v0.2.6) + This operation gets the list of multicast audio decoder configurations. """ return self.operator.call( "GetMulticastAudioDecoderConfigurations", @@ -696,10 +700,10 @@ def GetMulticastAudioDecoderConfigurations(self, ConfigurationToken=None): ) def SetMulticastAudioDecoderConfiguration(self, Configuration): - """This operation sets the MulticastAudioDecoderConfiguration. + """ + - !!! tip "Version History" - - Available since [`>=v0.2.6`](/onvif-python/releases/#v0.2.6) + This operation sets the MulticastAudioDecoderConfiguration. """ return self.operator.call( "SetMulticastAudioDecoderConfiguration", Configuration=Configuration diff --git a/onvif/services/provisioning.py b/onvif/services/provisioning.py index 96330baa..9766075f 100644 --- a/onvif/services/provisioning.py +++ b/onvif/services/provisioning.py @@ -6,11 +6,15 @@ class Provisioning(ONVIFService): - """Provisioning service client. + """ + + + + Provisioning service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 16.12 (December 2016) | + | **First introduced** | ONVIF 16.12 (December 2016) | | **Binding name** | `ProvisioningBinding` (`ver10/provisioning/wsdl/provisioning.wsdl`) | | **Operations** | [provisioning.wsdl](https://www.onvif.org/ver10/provisioning/wsdl/provisioning.wsdl) | | **Spec** | [Provisioning](https://www.onvif.org/specs/srv/ptz/ONVIF-Provisioning-Service-Spec.pdf) | diff --git a/onvif/services/ptz.py b/onvif/services/ptz.py index 23c7f6a1..91390ad0 100644 --- a/onvif/services/ptz.py +++ b/onvif/services/ptz.py @@ -6,11 +6,16 @@ class PTZ(ONVIFService): - """PTZ service client. + """ + + + + + PTZ service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | + | **First introduced** | ONVIF 1.0 (November 2008) | | **Binding name** | `PTZBinding` (`ver20/ptz/wsdl/ptz.wsdl`) | | **Operations** | [ptz.wsdl](https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl) | | **Spec** | [PTZ](https://www.onvif.org/specs/srv/ptz/ONVIF-PTZ-Service-Spec.pdf) | diff --git a/onvif/services/receiver.py b/onvif/services/receiver.py index 4bf1cc33..c002b0e3 100644 --- a/onvif/services/receiver.py +++ b/onvif/services/receiver.py @@ -6,11 +6,15 @@ class Receiver(ONVIFService): - """Receiver service client. + """ + + + + Receiver service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | + | **First introduced** | ONVIF 2.0 (November 2010) | | **Binding name** | `ReceiverBinding` (`ver10/receiver.wsdl`) | | **Operations** | [receiver.wsdl](https://www.onvif.org/ver10/receiver.wsdl) | | **Spec** | [Receiver](https://www.onvif.org/specs/srv/rcv/ONVIF-Receiver-Service-Spec.pdf) | diff --git a/onvif/services/recording.py b/onvif/services/recording.py index 140435f1..bf075d5e 100644 --- a/onvif/services/recording.py +++ b/onvif/services/recording.py @@ -6,11 +6,15 @@ class Recording(ONVIFService): - """Recording service client. + """ + + + + Recording service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | + | **First introduced** | ONVIF 2.0 (November 2010) | | **Binding name** | `RecordingBinding` (`ver10/recording.wsdl`) | | **Operations** | [recording.wsdl](https://www.onvif.org/ver10/recording.wsdl) | | **Spec** | [RecordingControl](https://www.onvif.org/specs/srv/rec/ONVIF-RecordingControl-Service-Spec.pdf) | @@ -255,10 +259,10 @@ def OverrideSegmentDuration( ) def ListRecordedSegments(self, Time, RecordingToken, MaxResults=None): - """Lists available recorded segments related to the specified RecordingToken. + """ + - !!! tip "Version History" - - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + Lists available recorded segments related to the specified RecordingToken. """ return self.operator.call( "ListRecordedSegments", @@ -275,11 +279,11 @@ def ExportRecordedSegments( StorageToken=None, Track=None, ): - """Exports the selected recorded segments (from existing recorded data) to the - storage attached to the given recording configuration. + """ + - !!! tip "Version History" - - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + Exports the selected recorded segments (from existing recorded data) to the + storage attached to the given recording configuration. """ return self.operator.call( "ExportRecordedSegments", @@ -291,10 +295,10 @@ def ExportRecordedSegments( ) def StopExportRecordedSegments(self, OperationToken): - """Stops the selected ExportRecordedSegments operation. + """ + - !!! tip "Version History" - - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + Stops the selected ExportRecordedSegments operation. """ return self.operator.call( "StopExportRecordedSegments", OperationToken=OperationToken diff --git a/onvif/services/replay.py b/onvif/services/replay.py index 33040b92..d0681157 100644 --- a/onvif/services/replay.py +++ b/onvif/services/replay.py @@ -6,11 +6,15 @@ class Replay(ONVIFService): - """Recording service client. + """ + + + + Recording service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | + | **First introduced** | ONVIF 2.0 (November 2010) | | **Binding name** | `ReplayBinding` (`ver10/replay.wsdl`) | | **Operations** | [replay.wsdl](https://www.onvif.org/ver10/replay.wsdl) | | **Spec** | [ReplayControl](https://www.onvif.org/specs/srv/replay/ONVIF-ReplayControl-Service-Spec.pdf) | diff --git a/onvif/services/schedule.py b/onvif/services/schedule.py index edcdfa6d..6787d744 100644 --- a/onvif/services/schedule.py +++ b/onvif/services/schedule.py @@ -7,11 +7,15 @@ # pylint: disable=redefined-outer-name class Schedule(ONVIFService): - """Schedule service client. + """ + + + + Schedule service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.6 (June 2015) | + | **First introduced** | ONVIF 2.6 (June 2015) | | **Binding name** | `ScheduleBinding` (`ver10/schedule/wsdl/schedule.wsdl`) | | **Operations** | [schedule.wsdl](https://www.onvif.org/ver10/schedule/wsdl/schedule.wsdl) | | **Spec** | [Scheduler](https://www.onvif.org/specs/srv/sched/ONVIF-Scheduler-Service-Spec.pdf) | diff --git a/onvif/services/search.py b/onvif/services/search.py index f14f67d8..0df85a25 100644 --- a/onvif/services/search.py +++ b/onvif/services/search.py @@ -6,11 +6,15 @@ class Search(ONVIFService): - """Search service client. + """ + + + + Search service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.1 (June 2011) split from Core 2.0 | + | **First introduced** | ONVIF 2.0 (November 2010) | | **Binding name** | `SearchBinding` (`ver10/search.wsdl`) | | **Operations** | [search.wsdl](https://www.onvif.org/ver10/search.wsdl) | | **Spec** | [RecordingSearch](https://www.onvif.org/specs/srv/rsrch/ONVIF-RecordingSearch-Service-Spec.pdf) | @@ -349,11 +353,11 @@ def SearchImageByNL( Similarity=None, MaxMatches=None, ): - """Starts a natural language search session and specifies the search - parameters. + """ + - !!! tip "Version History" - - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + Starts a natural language search session and specifies the search + parameters. """ return self.operator.call( "SearchImageByNL", @@ -369,10 +373,10 @@ def SearchImageByNL( def GetNLSearchResults( self, SearchToken, MinResults=None, MaxResults=None, WaitTime=None ): - """Gets results from a natural language search session. + """ + - !!! tip "Version History" - - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + Gets results from a natural language search session. """ return self.operator.call( "GetNLSearchResults", @@ -392,10 +396,10 @@ def SearchImageByImage( TargetImageData=None, MaxMatches=None, ): - """Starts an image-based search session and specifies the search parameters. + """ + - !!! tip "Version History" - - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + Starts an image-based search session and specifies the search parameters. """ return self.operator.call( "SearchImageByImage", @@ -411,10 +415,10 @@ def SearchImageByImage( def GetImageSearchResults( self, SearchToken, MinResults=None, MaxResults=None, WaitTime=None ): - """Gets results from an image-based search session. + """ + - !!! tip "Version History" - - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + Gets results from an image-based search session. """ return self.operator.call( "GetImageSearchResults", diff --git a/onvif/services/security/advancedsecurity.py b/onvif/services/security/advancedsecurity.py index 4748e28e..9cf08d4a 100644 --- a/onvif/services/security/advancedsecurity.py +++ b/onvif/services/security/advancedsecurity.py @@ -6,11 +6,15 @@ class AdvancedSecurity(ONVIFService): - """Security service client. + """ + + + + Security service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.4 (August 2013) | + | **First introduced** | ONVIF 2.4 (August 2013) | | **Binding name** | `AdvancedSecurityServiceBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | diff --git a/onvif/services/security/authorizationserver.py b/onvif/services/security/authorizationserver.py index a4759b79..b7edad35 100644 --- a/onvif/services/security/authorizationserver.py +++ b/onvif/services/security/authorizationserver.py @@ -6,11 +6,15 @@ class AuthorizationServer(ONVIFService): - """Security (AuthorizationServer) service client. + """ + + + + Security (AuthorizationServer) service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 23.12 (December 2023) | + | **First introduced** | ONVIF 23.12 (December 2023) | | **Binding name** | `AuthorizationServerBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | diff --git a/onvif/services/security/dot1x.py b/onvif/services/security/dot1x.py index 1ce065b3..abea8d27 100644 --- a/onvif/services/security/dot1x.py +++ b/onvif/services/security/dot1x.py @@ -6,11 +6,15 @@ class Dot1X(ONVIFService): - """Security (Dot1X) service client. + """ + + + + Security (Dot1X) service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 16.06 (June 2016) | + | **First introduced** | ONVIF 16.06 (June 2016) | | **Binding name** | `Dot1XBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | diff --git a/onvif/services/security/jwt.py b/onvif/services/security/jwt.py index 3bef5d4d..6aea843d 100644 --- a/onvif/services/security/jwt.py +++ b/onvif/services/security/jwt.py @@ -6,11 +6,15 @@ class JWT(ONVIFService): - """Security (JWT) service client. + """ + + + + Security (JWT) service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 23.12 (December 2023) | + | **First introduced** | ONVIF 23.12 (December 2023) | | **Binding name** | `JWTBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | diff --git a/onvif/services/security/keystore.py b/onvif/services/security/keystore.py index c440b5ad..0ce1f1dd 100644 --- a/onvif/services/security/keystore.py +++ b/onvif/services/security/keystore.py @@ -6,11 +6,15 @@ class Keystore(ONVIFService): - """Security (Keystore) service client. + """ + + + + Security (Keystore) service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.4 (August 2013) | + | **First introduced** | ONVIF 2.4 (August 2013) | | **Binding name** | `KeystoreBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | diff --git a/onvif/services/security/mediasigning.py b/onvif/services/security/mediasigning.py index 0b9e6d28..987b36ae 100644 --- a/onvif/services/security/mediasigning.py +++ b/onvif/services/security/mediasigning.py @@ -6,11 +6,15 @@ class MediaSigning(ONVIFService): - """Security (MediaSigning) service client. + """ + + + + Security (MediaSigning) service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 24.12 (December 2024) | + | **First introduced** | ONVIF 23.12 (December 2023) | | **Binding name** | `MediaSigningBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | diff --git a/onvif/services/security/tlsserver.py b/onvif/services/security/tlsserver.py index 1b766cb2..9e86a9b4 100644 --- a/onvif/services/security/tlsserver.py +++ b/onvif/services/security/tlsserver.py @@ -6,11 +6,15 @@ class TLSServer(ONVIFService): - """Security (TLSServer) service client. + """ + + + + Security (TLSServer) service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 2.4 (August 2013) | + | **First introduced** | ONVIF 2.4 (August 2013) | | **Binding name** | `TLSServerBinding` (`ver10/advancedsecurity/wsdl/advancedsecurity.wsdl`) | | **Operations** | [advancedsecurity.wsdl](https://www.onvif.org/ver10/advancedsecurity/wsdl/advancedsecurity.wsdl) | | **Spec** | [Security](https://www.onvif.org/specs/srv/security/ONVIF-Security-Service-Spec.pdf) | diff --git a/onvif/services/thermal.py b/onvif/services/thermal.py index 3a7be2d4..214e0392 100644 --- a/onvif/services/thermal.py +++ b/onvif/services/thermal.py @@ -6,11 +6,15 @@ class Thermal(ONVIFService): - """Thermal service client. + """ + + + + Thermal service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 16.06 (June 2016) | + | **First introduced** | ONVIF 16.06 (June 2016) | | **Binding name** | `ThermalBinding` (`ver10/thermal/wsdl/thermal.wsdl`) | | **Operations** | [thermal.wsdl](https://www.onvif.org/ver10/thermal/wsdl/thermal.wsdl) | | **Spec** | [Thermal](https://www.onvif.org/specs/srv/thermal/ONVIF-Thermal-Service-Spec.pdf) | diff --git a/onvif/services/uplink.py b/onvif/services/uplink.py index 64d7f8b7..f3f17f68 100644 --- a/onvif/services/uplink.py +++ b/onvif/services/uplink.py @@ -6,11 +6,15 @@ class Uplink(ONVIFService): - """Uplink service client. + """ + + + + Uplink service client. | Property | Details | | -------- | ------- | - | **First introduced** | ONVIF Release 18.12 (December 2018) | + | **First introduced** | ONVIF 18.12 (December 2018) | | **Binding name** | `UplinkBinding` (`ver10/uplink/wsdl/uplink.wsdl`) | | **Operations** | [uplink.wsdl](https://www.onvif.org/ver10/uplink/wsdl/uplink.wsdl) | | **Spec** | [Uplink](https://www.onvif.org/specs/srv/uplink/ONVIF-Uplink-Spec.pdf) | diff --git a/onvif/utils/discovery.py b/onvif/utils/discovery.py index 4e3c1903..3ef07616 100644 --- a/onvif/utils/discovery.py +++ b/onvif/utils/discovery.py @@ -24,7 +24,13 @@ class ONVIFDiscovery: - """Discover ONVIF devices using the WS-Discovery protocol. + """ + + + + + + Discover ONVIF devices using the WS-Discovery protocol. This class provides methods for discovering ONVIF-compliant devices on the local network using WS-Discovery multicast. @@ -38,7 +44,8 @@ class ONVIFDiscovery: interface (str | None): Network interface IP to bind to (default: auto-detect) !!! tip "Version History" - - Available since [`>=v0.1.6`](/onvif-python/releases/#v0.1.6) + - Changed in [`v0.4.0`](/onvif-python/releases/#v0.4.0): + ~~`WS_DISCOVERY_ADDRESS_IPv4`~~ → `WS_DISCOVERY_ADDRESS_IPV4` """ WS_DISCOVERY_PORT: int = 3702 @@ -57,7 +64,7 @@ class ONVIFDiscovery: "" "" "" - "" + "tds:Device" "" "" "" @@ -86,10 +93,11 @@ def __init__( self._local_ip: str | None = None def get_local_ip(self) -> str: - """Get local network interface IP address. + """ + + - !!! tip "Version History" - - Available since [`>=v0.1.6`](/onvif-python/releases/#v0.1.6) + Get local network interface IP address. Returns: Local IP address @@ -130,14 +138,16 @@ def get_local_ip(self) -> str: def discover( self, prefer_https: bool = False, search: str | None = None ) -> list[dict[str, Any]]: - """Discover ONVIF devices on the network. + """ + + - !!! tip "Version History" - - Available since [`>=v0.1.6`](/onvif-python/releases/#v0.1.6) + Discover ONVIF devices on the network. Args: prefer_https (bool): If True, prioritize HTTPS XAddrs when available - search (str | None): Optional search term to filter devices by types or scopes (case-insensitive) + search (str | None): Optional search term to filter devices + by types or scopes (case-insensitive) Returns: List of discovered devices (as dict); empty if none are available @@ -158,7 +168,7 @@ def discover( | `services` | `list[str]` | List of supported ONVIF services; empty if none are available | !!! tip "Version History" - - Added in [`>=v0.4.0`](/onvif-python/releases/#v0.4.0): `hostname`, `date_time`, and `services` + - Added in [`v0.4.0`](/onvif-python/releases/#v0.4.0): `hostname`, `date_time`, and `services` """ local_ip = self.get_local_ip() logger.info("Starting ONVIF device discovery (timeout: %ss)", self.timeout) diff --git a/onvif/utils/error_handlers.py b/onvif/utils/error_handlers.py index ee1bd29e..468212aa 100644 --- a/onvif/utils/error_handlers.py +++ b/onvif/utils/error_handlers.py @@ -1,4 +1,9 @@ """ + + + + + Error handling utilities for ONVIF operations. This module provides utilities to gracefully handle ONVIF SOAP errors, @@ -11,8 +16,8 @@ cases. !!! tip "Version History" - - Available since [`>=v0.0.7`](/onvif-python/releases/#v0.0.7) as `ONVIFErrorHandler` - - Refactor to module since [`>=v0.4.0`](/onvif-python/releases/#v0.4.0) + - Available since [`v0.0.7`](/onvif-python/releases/#v0.0.7) as `ONVIFErrorHandler` + - Refactor to module since [`v0.4.0`](/onvif-python/releases/#v0.4.0) !!! abstract "Features" - Detect `ActionNotSupported` SOAP faults @@ -53,10 +58,10 @@ def is_action_not_supported(exception: ONVIFOperationException | Fault) -> bool: """ - Check whether an exception is caused by an `ActionNotSupported` SOAP fault. + + - !!! tip "Version History" - - Available since [`>=v0.4.0`](/onvif-python/releases/#v0.4.0) + Check whether an exception is caused by an `ActionNotSupported` SOAP fault. Args: exception: The exception to inspect. Can be an @@ -117,10 +122,10 @@ def safe_call( log_error: bool = True, ) -> Any | None: """ - Safely call an ONVIF operation with graceful error handling. + + - !!! tip "Version History" - - Available since [`>=v0.4.0`](/onvif-python/releases/#v0.4.0) + Safely call an ONVIF operation with graceful error handling. Args: func (Callable): The callable that performs the ONVIF operation. @@ -133,7 +138,8 @@ def safe_call( Defaults to `True`. !!! tip "Version History" - - Changed in [`>=v0.4.0`](/onvif-python/releases/#v0.4.0): ~~`ignore_unsupported`~~ → `handle_unsupported`. + - Changed in [`v0.4.0`](/onvif-python/releases/#v0.4.0): + ~~`ignore_unsupported`~~ → `handle_unsupported`. Returns: The result returned by `func`, or `default` when the operation is @@ -189,10 +195,11 @@ def safe_call( def ignore_unsupported(func: Callable) -> Any | None: - """Decorator to ignore `ActionNotSupported` SOAP faults. + """ + + - !!! tip "Version History" - - Available since [`>=v0.4.0`](/onvif-python/releases/#v0.4.0) + Decorator to ignore `ActionNotSupported` SOAP faults. Args: func (Callable): The function to decorate. The function may accept positional diff --git a/onvif/utils/exceptions.py b/onvif/utils/exceptions.py index 7e2a8368..6dbe2368 100644 --- a/onvif/utils/exceptions.py +++ b/onvif/utils/exceptions.py @@ -9,7 +9,11 @@ # pylint: disable=too-many-nested-blocks,too-many-branches class ONVIFOperationException(Exception): # pylint: disable=line-too-long - """Enhanced exception wrapper for ONVIF operation failures. + """ + + + + Enhanced exception wrapper for ONVIF operation failures. This exception provides detailed error information including operation name, error category, SOAP fault details, and the original exception. @@ -20,9 +24,6 @@ class ONVIFOperationException(Exception): operation (str): Name of the ONVIF operation that failed original_exception (Exception): The underlying exception that was raised - !!! tip "Version History" - - Available since [`>=v0.0.1`](/onvif-python/releases/#v0.0.1) (first release) - ## Error Categories ### SOAP Error diff --git a/onvif/utils/plugins.py b/onvif/utils/plugins.py index 26e68583..ffd33302 100644 --- a/onvif/utils/plugins.py +++ b/onvif/utils/plugins.py @@ -1,6 +1,6 @@ """Auxiliary custom Zeep plugins outside the core scope. -All classes in this module inherit from Zeep's Plugin (`zeep.plugins`) class. +All classes in this module inherit from Zeep's Plugin (`zeep.Plugin`) class. """ from __future__ import annotations @@ -16,145 +16,12 @@ logger.addHandler(logging.NullHandler()) -class ONVIFParser(Plugin): - """Lightweight Zeep plugin for extracting XML elements from SOAP responses. - - The parser extracts text from XML elements matching configured XPath - expressions before Zeep parses the SOAP response. This is useful for - extracting elements that Zeep does not parse correctly, such as - `simpleContent` elements with attributes. - - Args: - extract_xpaths: Dictionary mapping extraction names to XPath expressions - - Attributes: - extract_xpaths: XPath expressions used to extract elements from SOAP - responses - - !!! tip "Version History" - - Available since [`>=v0.2.2`](/onvif-python/releases/#v0.2.2) - - ??? example "Usage" - ```python linenums="1" - from onvif import ONVIFClient, ONVIFParser - - parser = ONVIFParser({ - "topic": ".//{http://docs.oasis-open.org/wsn/b-2}Topic", - }) - - client = ONVIFClient( - host, port, username, password, plugins=[parser] - ) - - subscription = client.events().CreatePullPointSubscription() - pullpoint = client.pullpoint(subscription) - - msgs = pullpoint.PullMessages( - Timeout="PT5S", - MessageLimit=10, - ) - - topics = parser.get_extracted_texts( - "topic", - len(msgs.NotificationMessage), - ) - ``` - - ??? note "Notes" - - Uses Zeep's `ingress()` hook to access the raw SOAP response. - - The extraction cache is cleared before each SOAP response. - - Supports any XPath expression accepted by `lxml`. +class XMLCapturePlugin(Plugin): """ + + - def __init__(self, extract_xpaths: dict[str, str]): - """Initialize XML element parser. - - Args: - extract_xpaths: Dictionary mapping names to XPath expressions. - XPath expressions will be used to find elements in SOAP response. - - Example: - ```python - { - 'topic': './/{http://docs.oasis-open.org/wsn/b-2}Topic', - 'custom': './/ns:CustomElement' - } - ``` - """ - self.extract_xpaths: dict[str, str] = extract_xpaths - self._extracted_elements: dict[str, list[str | None]] = {} - - logger.debug( - "ONVIFParser initialized with XPaths: %s", list(extract_xpaths.keys()) - ) - - def ingress( - self, envelope: etree._Element, http_headers: dict[str, str], operation: Any - ) -> tuple[Any, dict[str, str]]: - """Process a SOAP response before Zeep deserializes it. - - This Zeep ``ingress`` hook inspects the raw SOAP response envelope and - extracts text from elements matching the configured XPath expressions. - The extracted values are stored temporarily and can be retrieved with - `get_extracted_texts`. - - The extraction cache is cleared before processing each response, so it - always contains values from the most recently processed SOAP response. - - Args: - envelope: Raw SOAP response envelope as an `lxml.etree.Element` - http_headers: HTTP response headers returned by the device - operation: Zeep operation associated with the SOAP response - - Returns: - A tuple containing the unchanged ``envelope`` and ``http_headers``. - Returning both values allows Zeep to continue processing the response - and allows other plugins in the chain to process it as well. - """ - # Auto-clear cache from previous response - self._extracted_elements = {} - - try: - # Extract elements using XPath from raw XML envelope - for name, xpath in self.extract_xpaths.items(): - elements = envelope.findall(xpath) - - # Extract text content from found elements - texts = [elem.text for elem in elements] - - if texts: - self._extracted_elements[name] = texts - logger.debug( - "ONVIFParser: Extracted %d '%s' elements", len(texts), name - ) - - except (ValueError, TypeError, AttributeError) as e: - logger.warning("ONVIFParser: Failed to extract elements: %s", e) - - return envelope, http_headers - - def get_extracted_texts(self, name: str, count: int) -> list[str | None]: - """Get extracted element texts by name. - - Args: - name (str): Name of the extracted elements (key from `extract_xpaths` dict) - count (int): Number of elements to return - - Returns: - List of element text values, padded with None if fewer elements were found. - Example: If 3 elements found but `count=5`, returns [text1, text2, text3, None, None] - """ - texts = self._extracted_elements.get(name, [])[:count] - - # Pad with None if not enough elements - while len(texts) < count: - texts.append(None) - - return texts - - -class XMLCapturePlugin(Plugin): - """Zeep plugin to capture and inspect SOAP XML requests and responses. + Zeep plugin to capture and inspect SOAP XML requests and responses. This plugin intercepts SOAP communication between the ONVIF client and device, capturing raw XML for debugging, logging, and analysis purposes. It's invaluable @@ -168,17 +35,16 @@ class XMLCapturePlugin(Plugin): history (list[dict[str, Any]]): All captured requests/responses with metadata !!! tip "Version History" - - Available since [`>=v0.0.6`](/onvif-python/releases/#v0.0.6) - - Moved to `plugins` since [`>=v0.4.0`](/onvif-python/releases/#v0.4.0) + - Moved to `plugins` since [`v0.4.0`](/onvif-python/releases/#v0.4.0) - !!! abstract "The plugin automatically captures" + !!! question "The plugin automatically captures" - Outgoing SOAP requests (`egress`) - Incoming SOAP responses (`ingress`) - HTTP headers for both directions - Operation names for context - Complete history of all transactions - !!! danger "Use Cases" + !!! bug "Use Cases" 1. **Debugging**: See exact SOAP messages being sent/received 2. **Learning**: Understand ONVIF protocol structure 3. **Testing**: Verify request format and response structure @@ -229,7 +95,7 @@ def __init__(self, pretty_print=True): self.history = [] # Store all requests/responses logger.debug("XMLCapturePlugin initialized (pretty_print=%s)", pretty_print) - def _format_xml(self, element) -> str: + def _format_xml(self, element: etree._Element) -> str: """Format XML element with proper indentation using lxml. Args: @@ -267,7 +133,11 @@ def egress( operation: Any, binding_options: dict[str, object], ) -> tuple[Any, dict[str, str]]: - """Capture a SOAP request before it is sent to the device. + """ + + + + Capture a SOAP request before it is sent to the device. This Zeep ``egress`` hook serializes the outgoing SOAP envelope and stores it in `last_sent_xml`. The request is also appended to `history` together @@ -319,7 +189,11 @@ def egress( def ingress( self, envelope: etree._Element, http_headers: dict[str, str], operation: Any ) -> tuple[Any, dict[str, str]]: - """Capture a SOAP response after it is received from the device. + """ + + + + Capture a SOAP response after it is received from the device. This Zeep ``ingress`` hook serializes the incoming SOAP envelope and stores it in `last_received_xml`. The response is also appended to `history` @@ -366,7 +240,11 @@ def ingress( return envelope, http_headers def get_last_request(self) -> str | None: - """Get the last captured request XML. + """ + + + + Get the last captured request XML. Returns: Last captured request XML @@ -374,7 +252,11 @@ def get_last_request(self) -> str | None: return self.last_sent_xml def get_last_response(self) -> str | None: - """Get the last captured response XML. + """ + + + + Get the last captured response XML. Returns: Last captured response XML @@ -382,7 +264,11 @@ def get_last_response(self) -> str | None: return self.last_received_xml def get_history(self) -> list: - """Get all captured requests and responses. + """ + + + + Get all captured requests and responses. Returns: List of all captured requests and responses. @@ -390,7 +276,12 @@ def get_history(self) -> list: return self.history def clear_history(self) -> None: - """Clear the capture history.""" + """ + + + + Clear the capture history. + """ history_count = len(self.history) self.history = [] self.last_sent_xml = None @@ -398,12 +289,18 @@ def clear_history(self) -> None: self.last_operation = None logger.debug("Cleared XML capture history (%d items)", history_count) - def save_to_file(self, request_file=None, response_file=None) -> None: - """Save captured XML to files. + def save_to_file( + self, request_file: str | None = None, response_file: str | None = None + ) -> None: + """ + + + + Save captured XML to files. Args: - request_file (str): Path to save request XML - response_file (str): Path to save response XML + request_file (str | None): Path to save request XML + response_file (str | None): Path to save response XML """ if request_file and self.last_sent_xml: try: @@ -422,8 +319,161 @@ def save_to_file(self, request_file=None, response_file=None) -> None: logger.error("Failed to save response XML to %s: %s", response_file, e) +class ONVIFParser(Plugin): + """ + + + + + Lightweight Zeep plugin for extracting XML elements from SOAP responses. + + The parser extracts text from XML elements matching configured XPath + expressions before Zeep parses the SOAP response. This is useful for + extracting elements that Zeep does not parse correctly, such as + `simpleContent` elements with attributes. + + Attributes: + extract_xpaths: XPath expressions used to extract elements from SOAP + responses + + !!! tip "Version History" + - Moved to `plugins` since [`v0.3.1`](/onvif-python/releases/#v0.3.1) + + ??? example "Usage" + ```python linenums="1" + from onvif import ONVIFClient, ONVIFParser + + parser = ONVIFParser({ + "topic": ".//{http://docs.oasis-open.org/wsn/b-2}Topic", + }) + + client = ONVIFClient( + host, port, username, password, plugins=[parser] + ) + + subscription = client.events().CreatePullPointSubscription() + pullpoint = client.pullpoint(subscription) + + msgs = pullpoint.PullMessages( + Timeout="PT5S", + MessageLimit=10, + ) + + topics = parser.get_extracted_texts( + "topic", + len(msgs.NotificationMessage), + ) + ``` + + ??? note "Notes" + - Uses Zeep's `ingress()` hook to access the raw SOAP response. + - The extraction cache is cleared before each SOAP response. + - Supports any XPath expression accepted by `lxml`. + """ + + def __init__(self, extract_xpaths: dict[str, str]): + """Initialize XML element parser. + + Args: + extract_xpaths: Dictionary mapping names to XPath expressions. + XPath expressions will be used to find elements in SOAP response. + + Example: + ```python + { + 'topic': './/{http://docs.oasis-open.org/wsn/b-2}Topic', + 'custom': './/ns:CustomElement' + } + ``` + """ + self.extract_xpaths: dict[str, str] = extract_xpaths + self._extracted_elements: dict[str, list[str | None]] = {} + + logger.debug( + "ONVIFParser initialized with XPaths: %s", list(extract_xpaths.keys()) + ) + + def ingress( + self, envelope: etree._Element, http_headers: dict[str, str], operation: Any + ) -> tuple[Any, dict[str, str]]: + """ + + + + Process a SOAP response before Zeep deserializes it. + + This Zeep ``ingress`` hook inspects the raw SOAP response envelope and + extracts text from elements matching the configured XPath expressions. + The extracted values are stored temporarily and can be retrieved with + `get_extracted_texts`. + + The extraction cache is cleared before processing each response, so it + always contains values from the most recently processed SOAP response. + + Args: + envelope: Raw SOAP response envelope as an `lxml.etree.Element` + http_headers: HTTP response headers returned by the device + operation: Zeep operation associated with the SOAP response + + Returns: + A tuple containing the unchanged ``envelope`` and ``http_headers``. + Returning both values allows Zeep to continue processing the response + and allows other plugins in the chain to process it as well. + """ + # Auto-clear cache from previous response + self._extracted_elements = {} + + try: + # Extract elements using XPath from raw XML envelope + for name, xpath in self.extract_xpaths.items(): + elements = envelope.findall(xpath) + + # Extract text content from found elements + texts = [elem.text for elem in elements] + + if texts: + self._extracted_elements[name] = texts + logger.debug( + "ONVIFParser: Extracted %d '%s' elements", len(texts), name + ) + + except (ValueError, TypeError, AttributeError) as e: + logger.warning("ONVIFParser: Failed to extract elements: %s", e) + + return envelope, http_headers + + def get_extracted_texts(self, name: str, count: int) -> list[str | None]: + """ + + + + Get extracted element texts by name. + + Args: + name (str): Name of the extracted elements (key from `extract_xpaths` dict) + count (int): Number of elements to return + + Returns: + List of element text values, padded with None if fewer elements were found. + Example: If 3 elements found but `count=5`, returns + [text1, text2, text3, None, None] + """ + texts = self._extracted_elements.get(name, [])[:count] + + # Pad with None if not enough elements + while len(texts) < count: + texts.append(None) + + return texts + + class ReferenceParametersPlugin(Plugin): - """Zeep plugin for injecting WS-Addressing reference parameters. + """ + + + + + Zeep plugin for injecting WS-Addressing reference parameters. The plugin adds WS-Addressing reference parameters to the SOAP ``Header`` of outgoing requests. It is primarily useful for ONVIF services whose @@ -434,13 +484,10 @@ class ReferenceParametersPlugin(Plugin): XML elements can be reused safely across requests. Attributes: - reference_parameters: XML elements to inject into outgoing SOAP - headers + reference_parameters (list[etree._Element]): XML elements to inject + into outgoing SOAP headers - !!! tip "Version History" - - Available since [`>=v0.3.1`](/onvif-python/releases/#v0.3.1) - - !!! note + !!! info The plugin supports both SOAP 1.1 and SOAP 1.2 envelope namespaces """ @@ -450,6 +497,7 @@ class ReferenceParametersPlugin(Plugin): ) def __init__(self, reference_parameters: list[etree._Element] | None = None): + """Initialize Reference Parameters injection""" self.reference_parameters = reference_parameters or [] def egress( @@ -459,7 +507,11 @@ def egress( operation: Any, binding_options: dict[str, object], ) -> tuple[Any, dict[str, str]]: - """Inject WS-Addressing reference parameters into a SOAP request. + """ + + + + Inject WS-Addressing reference parameters into a SOAP request. This Zeep ``egress`` hook adds the configured reference parameters to the SOAP ``Header`` before the request is sent to the device. diff --git a/onvif/utils/service.py b/onvif/utils/service.py index 0344f8f7..371c10d6 100644 --- a/onvif/utils/service.py +++ b/onvif/utils/service.py @@ -60,18 +60,20 @@ def _is_zeep_object(obj): class ONVIFService: - """Base class for all ONVIF service implementations. + """ + + + + Base class for all ONVIF service implementations. This abstract base class provides automatic error handling and consistent API behavior for all ONVIF services ([`Device`](../services/device.md), [`Media`](../services/media.md), [`PTZ`](../services/ptz.md), etc.). - !!! tip "Version History" - - Available since [`>=v0.1.8`](/onvif-python/releases/#v0.1.8) - !!! danger "All service classes inherit from `ONVIFService` to ensure" - Consistent exception handling across all ONVIF operations - - Automatic wrapping of errors into [`ONVIFOperationException`](../exceptions/onvif_exception.md) + - Automatic wrapping of errors into + [`ONVIFOperationException`](../exceptions/onvif_exception.md) - Uniform error reporting with operation names - Transparent method interception without explicit wrappers @@ -79,8 +81,10 @@ class ONVIFService: - Uses `__getattribute__` magic method to intercept all method calls - Automatically wraps ONVIF operations (methods starting with uppercase) - Preserves non-ONVIF methods, private methods, and attributes - - Converts all exceptions to [`ONVIFOperationException`](../exceptions/onvif_exception.md) for consistency - - Re-raises existing [`ONVIFOperationException`](../exceptions/onvif_exception.md) without double-wrapping + - Converts all exceptions to + [`ONVIFOperationException`](../exceptions/onvif_exception.md) for consistency + - Re-raises existing + [`ONVIFOperationException`](../exceptions/onvif_exception.md) without double-wrapping ??? note "Notes" - This is an abstract base class - don't instantiate directly @@ -90,13 +94,18 @@ class ONVIFService: - Compatible with all Python magic methods and properties ??? note "See Also" - - [`ONVIFOperationException`](../exceptions/onvif_exception.md): Exception class for wrapped errors + - [`ONVIFOperationException`](../exceptions/onvif_exception.md): + Exception class for wrapped errors - [`ONVIFOperator`](../core/onvif_operator.md): Low-level SOAP operation handler - - Device, Media, PTZ, etc.: Concrete service implementations + - Device, Media, PTZ, etc: Concrete service implementations """ def __getattribute__(self, name: str) -> Any: - """Intercept all method calls and wrap ONVIF operations with error handling. + """ + + + + Intercept all method calls and wrap ONVIF operations with error handling. This magic method is called for every attribute access on the service object. It intercepts ONVIF operation calls and wraps them with consistent error handling. @@ -111,7 +120,7 @@ def __getattribute__(self, name: str) -> Any: ONVIFOperationException: If the ONVIF operation fails !!! question "Method Interception Logic" - 1. Get the attribute using object.__getattribute__ + 1. Get the attribute using `object.__getattribute__` 2. Skip if not callable, private, or internal attribute 3. Check if method name starts with uppercase (ONVIF convention) 4. If yes, return wrapped version that catches and converts exceptions @@ -165,10 +174,11 @@ def wrapped_method(*args, **kwargs): def type(self, type_name: str) -> Any: """ - Create and return an instance of the specified ONVIF type. + + + - !!! tip "Version History" - - Available since [`>=v0.1.9`](/onvif-python/releases/#v0.1.9) + Create and return an instance of the specified ONVIF type. Args: type_name (str): Name of the type to create (e.g., 'SetHostname', 'SetIPAddressFilter') @@ -184,7 +194,9 @@ def type(self, type_name: str) -> Any: device = client.devicemgmt() newuser = device.type('CreateUsers') - newuser.User.append({"Username": 'new_user', "Password": 'new_password', "UserLevel": 'User'}) + newuser.User.append({ + "Username": 'new_user', "Password": 'new_password', "UserLevel": 'User' + }) device.CreateUsers(newuser) hostname = device.type('SetHostname') @@ -215,10 +227,11 @@ def type(self, type_name: str) -> Any: raise ONVIFOperationException(f"type({type_name})", e) from e def operations(self) -> list[str] | list: - """List all available operations for this service. + """ + + - !!! tip "Version History" - - Available since [`>=v0.2.0`](/onvif-python/releases/#v0.2.0) + List all available operations for this service. Returns: List of operation names that can be used with `type()` method @@ -266,10 +279,10 @@ def operations(self) -> list[str] | list: def desc(self, method_name: str) -> dict: """ - Get documentation and parameter information for a specific operation/method. + + - !!! tip "Version History" - - Available since [`>=v0.2.0`](/onvif-python/releases/#v0.2.0) + Get documentation and parameter information for a specific operation/method. Args: method_name (str): Name of the method to describe (e.g., 'GetDeviceInformation', 'SetHostname') @@ -383,16 +396,18 @@ def desc(self, method_name: str) -> dict: def to_dict(self, zeep_object: Any) -> dict: """ - Convert a zeep object (result from ONVIF operation) to Python dictionary. + + + - !!! tip "Version History" - - Available since [`>=v0.2.9`](/onvif-python/releases/#v0.2.9) + Convert a zeep object (result from ONVIF operation) to Python dictionary. Args: zeep_object (Any): The zeep object returned from ONVIF operations Returns: - Python dictionary representation of the zeep object + Python `dict` representation of the Zeep object.
Returns an empty dict + `{}` if `zeep_object` is `None` or if conversion fails for any reason. Example: ```python linenums="1" diff --git a/onvif/utils/wsdl.py b/onvif/utils/wsdl.py index 1f712b59..25a4cd51 100644 --- a/onvif/utils/wsdl.py +++ b/onvif/utils/wsdl.py @@ -13,7 +13,11 @@ class ONVIFWSDL: - """WSDL file manager for ONVIF services. + """ + + + + WSDL file manager for ONVIF services. This class manages WSDL (Web Services Description Language) file paths, bindings, and namespaces for all ONVIF services. It provides a centralized mapping between @@ -26,17 +30,6 @@ class ONVIFWSDL: BASE_DIR (str): Default base directory for WSDL files (Built-in) WSDL_MAP (dict[str, dict[str, Any]] | None): Will be initialized when first accessed - !!! tip "Version History" - - Available since [`>=v0.1.0`](/onvif-python/releases/#v0.1.0) - - !!! abstract "Features" - - Centralized WSDL definition mapping for all ONVIF services - - Support for multiple ONVIF versions (ver10, ver20) - - Custom WSDL directory support (global and per-call) - - Automatic path resolution for built-in and custom WSDLs - - Service discovery with namespace and binding information - - File existence validation - !!! warning "WSDL Structure" Built-in WSDLs are organized in the ONVIF standard directory structure: @@ -67,7 +60,7 @@ class ONVIFWSDL: └── ptz.wsdl ``` - !!! question "Service Definition Format" + !!! abstract "Service Definition Format" Each service has a definition containing: - `filename` : WSDL file name @@ -75,7 +68,7 @@ class ONVIFWSDL: - `binding`: SOAP binding name (e.g., "DeviceBinding") - `namespace`: XML namespace URI (e.g., "http://www.onvif.org/ver10/device/wsdl") - ??? tip "Custom WSDL Directory Priority" + ??? question "Custom WSDL Directory Priority" 1. Per-call `custom_wsdl_dir` parameter (highest priority) 2. Global `_custom_wsdl_dir` setting 3. Built-in `BASE_DIR` (default) @@ -102,10 +95,11 @@ class ONVIFWSDL: @classmethod def set_custom_wsdl_dir(cls, custom_dir: str) -> None: - """Set global custom WSDL directory for all services. + """ + + - !!! tip "Version History" - - Available since [`>=v0.1.0`](/onvif-python/releases/#v0.1.0) + Set global custom WSDL directory for all services. Args: custom_dir (str): Path to directory containing custom WSDL files @@ -123,10 +117,11 @@ def set_custom_wsdl_dir(cls, custom_dir: str) -> None: @classmethod def get_custom_wsdl_dir(cls) -> str | None: - """Get current global custom WSDL directory. + """ + + - !!! tip "Version History" - - Available since [`>=v0.1.0`](/onvif-python/releases/#v0.1.0) + Get current global custom WSDL directory. Returns: Current custom WSDL directory, or None if using built-in @@ -143,10 +138,11 @@ def get_custom_wsdl_dir(cls) -> str | None: @classmethod def clear_custom_wsdl_dir(cls) -> None: - """Clear custom WSDL directory, revert to built-in WSDLs. + """ + + - !!! tip "Version History" - - Available since [`>=v0.1.0`](/onvif-python/releases/#v0.1.0) + Clear custom WSDL directory, revert to built-in WSDLs. Example: ```python linenums="1" @@ -258,10 +254,11 @@ def _ensure_wsdl_map_initialized(cls) -> None: @classmethod def get_wsdl_map(cls) -> dict[str, dict[str, Any]]: - """Get the complete WSDL map for all services. + """ + + - !!! tip "Version History" - - Available since [`>=v0.2.11`](/onvif-python/releases/#v0.2.11) + Get the complete WSDL map for all services. """ cls._ensure_wsdl_map_initialized() @@ -274,14 +271,15 @@ def get_wsdl_map(cls) -> dict[str, dict[str, Any]]: def get_definition( cls, service: str, version: str = "ver10", custom_wsdl_dir=None ) -> dict: - """Get WSDL definition for a specific ONVIF service. + """ + + + + Get WSDL definition for a specific ONVIF service. Returns complete WSDL definition including file path, SOAP binding name, and XML namespace for the requested service and version. - !!! tip "Version History" - - Available since [`>=v0.1.0`](/onvif-python/releases/#v0.1.0) - Args: service (str): Service name (e.g., "devicemgmt", "media", "ptz"). version (str): ONVIF version (default: "ver10"). @@ -302,7 +300,7 @@ def get_definition( | `namespace` | `str` | XML namespace URI | !!! tip "Version History" - - Added in [`>=v0.4.5`](/onvif-python/releases/#v0.4.5): `filename` + - Added in [`v0.4.5`](/onvif-python/releases/#v0.4.5): `filename` ??? note - Most services use ver10, some newer ones use ver20 diff --git a/onvif/utils/zeep.py b/onvif/utils/zeep.py index 5df4c221..e3fb2da2 100644 --- a/onvif/utils/zeep.py +++ b/onvif/utils/zeep.py @@ -16,16 +16,17 @@ # pylint: disable=too-many-branches,too-many-nested-blocks,too-many-return-statements class ZeepPatcher: - """Utility for patching zeep SOAP library to handle ONVIF `xsd:any` fields. + """ + + + + Utility for patching zeep SOAP library to handle ONVIF `xsd:any` fields. This class patches the zeep library to better parse `xsd:any` fields commonly found in ONVIF SOAP responses. Without this patch, `xsd:any` fields remain as raw XML elements, making them difficult to work with. The patch converts them into structured dictionaries with proper type conversion. - !!! tip "Version History" - - Available since [`>=v0.0.4`](/onvif-python/releases/#v0.0.4) - !!! failure "The Problem" ONVIF uses `xsd:any` extensively for extensibility. By default, zeep doesn't parse these fields - it just stores raw XML elements. This makes accessing @@ -369,7 +370,11 @@ def _zeep_object_to_dict(obj): @staticmethod def flatten_xsd_any_fields(obj, _visited=None) -> Any: - """Post-process zeep objects to flatten `xsd:any` fields (`_value_1`, `_value_2`, + """ + + + + Post-process zeep objects to flatten `xsd:any` fields (`_value_1`, `_value_2`, etc.) into the main object. Zeep uses `_value_N` fields to store parsed content from `xsd:any` elements. @@ -383,9 +388,6 @@ def flatten_xsd_any_fields(obj, _visited=None) -> Any: This handles all `xsd:any` occurrences (`_value_1`, `_value_2`, `_value_3`, etc.), not just the first one. - !!! tip "Version History" - - Available since [`>=v0.0.4`](/onvif-python/releases/#v0.0.4) - Args: obj (XsdAny): The zeep object to process _visited (XsdAny): Set of visited object IDs to prevent infinite recursion @@ -626,14 +628,15 @@ def flatten_xsd_any_fields(obj, _visited=None) -> Any: @classmethod def apply_patch(cls): - """Inject the custom `parse_xmlelements` method into `zeep.xsd.elements.any.Any`. + """ + + + + Inject the custom `parse_xmlelements` method into `zeep.xsd.elements.any.Any`. This enables better parsing of `xsd:any` fields in ONVIF SOAP responses. Should be called once at application startup. - !!! tip "Version History" - - Available since [`>=v0.0.4`](/onvif-python/releases/#v0.0.4) - Example: ```python linenums="1" from onvif import ZeepPatcher @@ -652,12 +655,13 @@ def apply_patch(cls): @classmethod def remove_patch(cls): - """Restore the original `parse_xmlelements` method. + """ + + - Reverts zeep to its original behavior. Useful for testing or debugging. + Restore the original `parse_xmlelements` method. - !!! tip "Version History" - - Available since [`>=v0.0.4`](/onvif-python/releases/#v0.0.4) + Reverts zeep to its original behavior. Useful for testing or debugging. Example: ```python linenums="1" @@ -676,10 +680,11 @@ def remove_patch(cls): @classmethod def is_patched(cls) -> bool: - """Check if the patch is currently applied. + """ + + - !!! tip "Version History" - - Available since [`>=v0.0.4`](/onvif-python/releases/#v0.0.4) + Check if the patch is currently applied. Returns: `True` if patch is active, `False` otherwise diff --git a/pyproject.toml b/pyproject.toml index 82fe2baf..73fcb82d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -78,6 +78,8 @@ docs = [ "mkdocs-material>=9.7.7,<10.0.0", "mkdocstrings[python]>=1.0.0,<3.0.0", "mkdocs-git-authors-plugin>=0.10.0,<1.0.0", + "mkdocs-git-revision-date-localized-plugin>=1.6.0,<2.0.0", + "mkdocs-minify-plugin>=0.8.0,<1.0.0", ] [project.scripts] @@ -165,6 +167,7 @@ exclude = [ "^temp/", "^build/", "^site/", + "^docs/", ] [tool.coverage.run] From 53063593e4d9790c0973be77410b4c75ffef3fa2 Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Sun, 18 Oct 2026 19:43:17 +0700 Subject: [PATCH 17/37] feat(docs): Enhance GitHub releases page navigation and styling (#181) --- docs/javascripts/github-releases.js | 550 ++++++++++++++++++++++++---- docs/releases.md | 22 +- docs/stylesheets/extra.css | 149 +++++++- 3 files changed, 631 insertions(+), 90 deletions(-) diff --git a/docs/javascripts/github-releases.js b/docs/javascripts/github-releases.js index 7db63253..7ad60e91 100644 --- a/docs/javascripts/github-releases.js +++ b/docs/javascripts/github-releases.js @@ -57,7 +57,7 @@ function createReleaseNav(releases) { const releaseItem = document.createElement("li"); releaseItem.className = - "md-nav__item md-nav__item--nested github-releases-nav"; + "md-nav__item md-nav__item--pruned github-releases-nav"; const toggleId = "__nav_releases"; @@ -122,16 +122,17 @@ function createReleaseNav(releases) { )}`; const title = document.createElement("span"); + title.className = "md-ellipsis"; + title.textContent = release.tag_name.replace("v", ""); - const date = new Date(release.published_at); - const year = date.getFullYear(); - const month = String(date.getMonth() + 1).padStart(2, "0"); - const day = String(date.getDate()).padStart(2, "0"); - const formattedDate = `${year}-${month}-${day}`; + const date = document.createElement("small"); + date.className = "github-release__date_title"; - title.className = "md-ellipsis"; - title.textContent = `${release.tag_name} (${formattedDate})`; + const publishedAt = new Date(release.published_at); + + date.textContent = formatReleaseDate(publishedAt); + title.append(" ", date); link.appendChild(title); item.appendChild(link); releaseList.appendChild(item); @@ -200,79 +201,328 @@ function renderRelease(releases, tag = null) { const article = document.createElement("article"); article.className = "github-release"; - const heading = document.createElement("h2"); - heading.textContent = release.name || release.tag_name; + const heading = document.createElement("h1"); + heading.append(document.createTextNode(release.tag_name.replace("v", ""))); - const metadataElement = document.createElement("p"); - metadataElement.className = "github-release__metadata"; + const latestRelease = releases.find( + (item) => !item.draft && !item.prerelease + ); - if (release.immutable || release.tag_name || release.published_at) { - if(release.published_at){ - const dateElement = document.createElement("span"); - dateElement.className = "github-release__date"; + if (latestRelease?.id === release.id) { + const badge = document.createElement("span"); + badge.className = "github-release__badge"; + badge.textContent = "Latest"; - const date = new Date(release.published_at); - const year = date.getFullYear(); - const month = date.toLocaleString("en-US", { month: "long" }); - const day = String(date.getDate()).padStart(2, "0"); + heading.append(" ", badge); + } - dateElement.textContent = `🗓️ ${year}-${month}-${day}`; - metadataElement.appendChild(dateElement); - } + const dateHeading = document.createElement("h1"); + dateHeading.className = "github-release__date_header"; - if (release.immutable) { - const immutableElement = document.createElement("span"); - immutableElement.className = "github-release__immutable"; + const date = document.createElement("small"); - const lockIcon = document.createElement("span"); - lockIcon.textContent = "🔒"; - lockIcon.setAttribute("aria-hidden", "true"); + const publishedAt = new Date(release.published_at); + date.textContent = formatReleaseDate(publishedAt) - const immutableText = document.createElement("span"); - immutableText.textContent = "Immutable"; + dateHeading.appendChild(date); - immutableElement.appendChild(lockIcon); - immutableElement.appendChild(immutableText); - metadataElement.appendChild(immutableElement); - } + const header = document.createElement("div"); + header.className = "github-release__header"; - if (release.tag_name) { - const tagElement = document.createElement("span"); - tagElement.className = "github-release__tag"; + header.appendChild(heading); + header.appendChild(dateHeading); - const tagIcon = document.createElement("span"); - tagIcon.textContent = "🏷️"; - tagIcon.setAttribute("aria-hidden", "true"); + const hr = document.createElement("hr"); - const tagText = document.createElement("span"); - tagText.textContent = release.tag_name; + const metadata = document.createElement("div"); + metadata.className = "github-release__metadata"; - tagElement.appendChild(tagIcon); - tagElement.appendChild(tagText); - metadataElement.appendChild(tagElement); - } + const author = document.createElement("span"); + author.className = "github-release__author"; + + const username = release.author?.login; + + author.textContent = username + ? `@${username} released this ` + : "Released "; + + const time = document.createElement("time"); + time.className = "github-release__time"; + time.dateTime = release.published_at; + time.textContent = formatRelativeTime(release.published_at); + + author.appendChild(time); + + const releaseLink = document.createElement("a"); + releaseLink.className = "github-release__link"; + + const releaseUrl = new URL(release.html_url); + if ( + releaseUrl.protocol === "https:" && + releaseUrl.hostname === "github.com" + ) { + releaseLink.href = releaseUrl.href; + } else { + releaseLink.removeAttribute("href"); } + releaseLink.target = "_blank"; + releaseLink.rel = "noopener noreferrer"; + releaseLink.textContent = "Go to release"; + releaseLink.dataset.tooltip = "View release on GitHub"; + + metadata.append(author, releaseLink); + const body = document.createElement("div"); body.className = "github-release__body"; const markdownHtml = marked.parse( - processGitHubReferences(release.body || "") + processGitHubReferences(release.body || "", release.tag_name) ); const safeFragment = DOMPurify.sanitize(markdownHtml, { RETURN_DOM_FRAGMENT: true, }); + convertGitHubAlerts(safeFragment); + body.appendChild(safeFragment); - article.appendChild(heading); - article.appendChild(metadataElement); + body.querySelectorAll("a[href]").forEach((link) => { + link.target = "_blank"; + link.rel = "noopener noreferrer"; + + const url = new URL(link.href); + + if (url.hostname !== "github.com") { + return; + } + + const match = url.pathname.match( + /^\/([^/]+)\/([^/]+)\/(pull|issues)\/(\d+)\/?$/ + ); + + if (match) { + const [, , , type, number] = match; + link.dataset.tooltip = + type === "pull" + ? `Pull Request #${number}` + : `Issue #${number}`; + + return; + } + + const commitMatch = url.pathname.match( + /^\/([^/]+)\/([^/]+)\/commit\/([a-f0-9]{7,40})\/?$/i + ); + + if (commitMatch) { + link.dataset.tooltip = `Commit ${commitMatch[3].slice(0, 7)}`; + return; + } + + const profileMatch = url.pathname.match(/^\/([a-zA-Z0-9-]+)\/?$/); + + if (profileMatch) { + link.dataset.tooltip = `GitHub user @${profileMatch[1]}`; + } + + const compareMatch = url.pathname.match( + /^\/([^/]+)\/([^/]+)\/compare\/([^/]+)\.\.\.([^/]+)\/?$/ + ); + + if (compareMatch) { + const [, , , base, head] = compareMatch; + link.dataset.tooltip = `Compare ${base} → ${head}`; + return; + } + + const repositoryMatch = url.pathname.match( + /^\/([^/]+)\/([^/]+)\/?$/ + ); + + if (repositoryMatch) { + const [, owner, repo] = repositoryMatch; + link.dataset.tooltip = `GitHub repository ${owner}/${repo}`; + return; + } + + const actionRunMatch = url.pathname.match( + /^\/([^/]+)\/([^/]+)\/actions\/runs\/(\d+)\/?$/ + ); + + if (actionRunMatch) { + link.dataset.tooltip = `GitHub Actions Run #${actionRunMatch[3]}`; + return; + } + }); + + article.appendChild(header); + article.appendChild(hr); + article.appendChild(metadata); article.appendChild(body); container.replaceChildren(article); } +function formatReleaseDate(dateString) { + return new Date(dateString).toLocaleDateString(navigator.language, { + year: "numeric", + month: "long", + day: "2-digit", + }); +} + +function formatRelativeTime(dateString) { + const date = new Date(dateString); + const seconds = Math.floor((date.getTime() - Date.now()) / 1000); + const units = [ + ["year", 365 * 24 * 60 * 60], + ["month", 30 * 24 * 60 * 60], + ["week", 7 * 24 * 60 * 60], + ["day", 24 * 60 * 60], + ["hour", 60 * 60], + ["minute", 60], + ]; + + for (const [unit, secondsPerUnit] of units) { + if (Math.abs(seconds) >= secondsPerUnit) { + return new Intl.RelativeTimeFormat(navigator.language, { + numeric: "auto", + }).format(Math.round(seconds / secondsPerUnit), unit); + } + } + + return "just now"; +} + +function updateReleaseTOC() { + const body = document.querySelector(".github-release__body"); + const nav = document.querySelector( + ".md-sidebar--secondary .md-nav--secondary" + ); + + if (!body || !nav) { + return; + } + + // Create the TOC title if it doesn't exist. + let title = nav.querySelector(":scope > .md-nav__title"); + + if (!title) { + title = document.createElement("label"); + title.className = "md-nav__title"; + title.htmlFor = "__toc"; + + const icon = document.createElement("span"); + icon.className = "md-nav__icon md-icon"; + + title.appendChild(icon); + title.append(" Table of contents"); + nav.prepend(title); + } + + // Create the root TOC list if it doesn't exist. + let toc = nav.querySelector(":scope > .md-nav__list"); + + if (!toc) { + toc = document.createElement("ul"); + toc.className = "md-nav__list"; + toc.dataset.mdComponent = "toc"; + nav.appendChild(toc); + } + + const headings = body.querySelectorAll("h2, h3, h4"); + const usedIds = new Set(); + const stack = [{ level: 1, list: toc }]; + + toc.replaceChildren(); + + headings.forEach((heading, index) => { + const base = + heading.textContent + .trim() + .toLowerCase() + .replace(/[^\w\s-]/g, "") + .replace(/\s+/g, "-") || `section-${index + 1}`; + + let id = base; + let suffix = 1; + + while ( + usedIds.has(id) || + (document.getElementById(id) && + document.getElementById(id) !== heading) + ) { + id = `${base}-${suffix++}`; + } + + usedIds.add(id); + heading.id = id; + + const level = Number(heading.tagName.substring(1)); + + // Find the parent list for this heading level. + while (stack.length > 1 && stack.at(-1).level >= level) { + stack.pop(); + } + + const parentList = stack.at(-1).list; + + const item = document.createElement("li"); + item.className = "md-nav__item"; + + const link = document.createElement("a"); + link.className = "md-nav__link"; + link.href = `#${encodeURIComponent(id)}`; + + const text = document.createElement("span"); + text.className = "md-ellipsis"; + text.textContent = heading.textContent.trim(); + + link.appendChild(text); + + link.addEventListener("click", (event) => { + event.preventDefault(); + + heading.scrollIntoView({ + behavior: "smooth", + block: "start", + }); + }); + + item.appendChild(link); + parentList.appendChild(item); + + // Create a nested navigation list for child headings. + const childList = document.createElement("ul"); + childList.className = "md-nav__list"; + + const childNav = document.createElement("nav"); + childNav.className = "md-nav"; + childNav.setAttribute( + "aria-label", + heading.textContent.trim() + ); + + childNav.appendChild(childList); + item.appendChild(childNav); + + stack.push({ level, list: childList }); + }); + + // Remove empty child navigation lists. + toc.querySelectorAll("li").forEach((item) => { + const childNav = item.querySelector(":scope > nav.md-nav"); + + if (childNav && !childNav.querySelector(".md-nav__item")) { + childNav.remove(); + } + }); + + nav.hidden = headings.length === 0; +} + async function initializeReleases() { try { const data = await loadReleases(); @@ -291,7 +541,14 @@ async function initializeReleases() { pendingReleaseTag ?? decodeURIComponent(window.location.hash.substring(1)); + const { default: markedAlert } = await import( + "https://cdn.jsdelivr.net/npm/marked-alert@2.1.2/+esm" + ); + + marked.use(markedAlert()); + renderRelease(data, tag || null); + updateReleaseTOC(); pendingReleaseTag = null; updateActiveReleaseLink(); @@ -301,18 +558,106 @@ async function initializeReleases() { document.documentElement.scrollTop = 0; document.body.scrollTop = 0; }, 100); + + updateReleaseNavigationState(); } catch (error) { console.error("Failed to load GitHub releases:", error); const container = document.getElementById("github-releases"); if (container) { - container.innerHTML = - "

Failed to load releases from GitHub.

"; + const message = document.createElement("p"); + message.textContent = "Failed to load releases from GitHub."; + container.replaceChildren(message); } } } +function convertGitHubAlerts(fragment) { + const alertTypes = [ + "note", + "tip", + "important", + "warning", + "caution", + ]; + + fragment.querySelectorAll(".markdown-alert").forEach((alert) => { + const type = alertTypes.find((name) => + alert.classList.contains(`markdown-alert-${name}`), + ); + + if (!type) { + return; + } + + alert.className = `admonition ${type}`; + + const title = alert.querySelector(".markdown-alert-title"); + + if (title) { + title.className = "admonition-title"; + title.querySelectorAll("svg").forEach((svg) => svg.remove()); + title.textContent = title.textContent.trim(); + } + }); +} + + +function updateReleaseNavigationState() { + const path = window.location.pathname.replace(/\/+$/, ""); + const isReleasesPage = path.endsWith("/releases"); + + const placeholder = document.querySelector( + '.md-nav--primary > .md-nav__list > .md-nav__item > a[href$="/releases/"]' + )?.parentElement; + + const releaseNav = document.querySelector( + ".github-releases-nav" + ); + + if (!placeholder || !releaseNav) { + return; + } + + placeholder.classList.toggle( + "md-nav__item--active", + !isReleasesPage + ); + + releaseNav.classList.toggle( + "md-nav__item--active", + isReleasesPage + ); + + releaseNav.classList.toggle( + "md-nav__item--pruned", + !isReleasesPage + ); + + const placeholderLink = placeholder.querySelector( + ":scope > a.md-nav__link" + ); + + if (placeholderLink) { + placeholderLink.classList.toggle( + "md-nav__link--active", + !isReleasesPage + ); + } + + releaseNav.querySelectorAll(".md-nav__link").forEach((link) => { + const isActive = + isReleasesPage && + new URL(link.href, window.location.href).hash === + window.location.hash && + new URL(link.href, window.location.href).pathname === + window.location.pathname; + + link.classList.toggle("md-nav__link--active", isActive); + }); +} + if (typeof document$ !== "undefined") { document$.subscribe(() => { initializeReleases(); @@ -366,24 +711,30 @@ function updateActiveReleaseLink() { const releaseLinks = document.querySelectorAll( ".github-releases-nav a[href*='/releases/#']" ); - const currentHash = window.location.hash; + + const path = window.location.pathname.replace(/\/+$/, ""); + const isReleasesPage = path.endsWith("/releases"); + + const currentTag = window.location.hash + ? decodeURIComponent(window.location.hash.slice(1)) + : isReleasesPage + ? releases[0]?.tag_name + : null; releaseLinks.forEach((link) => { - const url = new URL(link.href); - const linkHash = url.hash; - const li = link.closest("li"); + const linkTag = decodeURIComponent( + new URL(link.href).hash.slice(1) + ); - if (li) { - li.classList.remove("md-nav__item--active"); - } - link.classList.remove("md-nav__link--active"); + const isActive = + isReleasesPage && + currentTag !== null && + linkTag === currentTag; - if (linkHash === currentHash) { - if (li) { - li.classList.add("md-nav__item--active"); - } - link.classList.add("md-nav__link--active"); - } + const item = link.closest("li"); + + item?.classList.toggle("md-nav__item--active", isActive); + link.classList.toggle("md-nav__link--active", isActive); }); } @@ -419,6 +770,7 @@ document.addEventListener("click", (event) => { if (releasesLoaded) { setTimeout(() => { renderRelease(releases, pendingReleaseTag); + updateReleaseTOC(); pendingReleaseTag = null; restoreReleaseNavState(); updateActiveReleaseLink(); @@ -435,8 +787,17 @@ if (typeof document$ !== "undefined") { }); } -function processGitHubReferences(markdown) { - let text = markdown; +function processGitHubReferences(markdown, tag) { + const htmlBlocks = []; + + // Protect HTML tags from Markdown URL transformations. + let text = markdown.replace( + /<[^>]+>/g, + (match) => { + const index = htmlBlocks.push(match) - 1; + return `HTMLBLOCKPLACEHOLDER${index}END`; + }, + ); // Convert GitHub issue/PR URLs to # references. text = text.replace( @@ -444,12 +805,12 @@ function processGitHubReferences(markdown) { (_, owner, repo, type, number) => { const repository = `${owner}/${repo}`; const url = `https://github.com/${repository}/${type}/${number}`; + const label = + repository === GITHUB_REPOSITORY + ? `#${number}` + : `${repository}#${number}`; - if (repository === GITHUB_REPOSITORY) { - return `[#${number}](${url})`; - } - - return `[${repository}#${number}](${url})`; + return `[${label}](${url})`; }, ); @@ -459,12 +820,13 @@ function processGitHubReferences(markdown) { (_, owner, repo, hash) => { const repository = `${owner}/${repo}`; const url = `https://github.com/${repository}/commit/${hash}`; + const shortHash = hash.substring(0, 7); + const label = + repository === GITHUB_REPOSITORY + ? `\`${shortHash}\`` + : `${repository}@\`${shortHash}\``; - if (repository === GITHUB_REPOSITORY) { - return `[\`${hash.substring(0, 7)}\`](${url})`; - } - - return `[${repository}@\`${hash.substring(0, 7)}\`](${url})`; + return `[${label}](${url})`; }, ); @@ -484,5 +846,37 @@ function processGitHubReferences(markdown) { }) .join(""); + // Convert GitHub compare URLs to version range links. + text = text.replace( + /https:\/\/github\.com\/([^/\s]+)\/([^/\s]+)\/compare\/([^/\s]+)\.\.\.([^/\s]+)/g, + (_, owner, repo, base, head) => { + const repository = `${owner}/${repo}`; + const url = `https://github.com/${repository}/compare/${base}...${head}`; + + return repository === GITHUB_REPOSITORY + ? `[\`${base}...${head}\`](${url})` + : `[${repository}: \`${base}...${head}\`](${url})`; + }, + ); + + // Convert relative file links to GitHub release source links. + text = text.replace( + /(\[[^\]]+\])\((\.\/[^)\s]+)\)/g, + (_, label, path) => + `${label}(https://github.com/${GITHUB_REPOSITORY}/blob/${tag}/${path.slice(2)})`, + ); + + // Convert plain GitHub repository URLs to Markdown links. + text = text.replace( + /(? `[${owner}/${repo}](${url})`, + ); + + // Restore protected HTML tags. + text = text.replace( + /HTMLBLOCKPLACEHOLDER(\d+)END/g, + (_, index) => htmlBlocks[Number(index)], + ); + return text; } \ No newline at end of file diff --git a/docs/releases.md b/docs/releases.md index f73f9c30..fa8a36eb 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -1,4 +1,24 @@ -# Releases +--- +comments: true +--- + + + +#

Loading releases...

diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 6a152bb3..237ccf84 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -55,6 +55,10 @@ display: none; } +.md-header__topic:first-child { + font-weight: 550; +} + .external-link-icon { display: inline-flex; width: 0.8em; @@ -85,24 +89,146 @@ margin-bottom: 2rem; } +.github-release__body { + margin-top: 0rem; +} + +/* Hide the Releases toggle label on desktop */ +@media screen and (min-width: 76.25em) { + .github-releases-nav > label.md-nav__link { + display: none; + } +} + +/* Inactive date */ +.github-releases-nav .github-release__date_title { + color: var(--md-default-fg-color--light); +} + +/* Hovered release link */ +.github-releases-nav .md-nav__link:hover .github-release__date_title { + color: inherit; +} + +/* Active release link */ +.github-releases-nav .md-nav__link--active .github-release__date_title { + color: inherit; +} + +/* External link tooltip */ +.github-release a[data-tooltip] { + position: relative; +} + +.github-release a[data-tooltip]::after { + content: attr(data-tooltip); + position: absolute; + bottom: calc(100% + 0.3rem); + left: 50%; + z-index: 100; + width: max-content; + max-width: 16rem; + padding: 0.3rem 0.5rem; + border-radius: 0.5rem; + background: var(--md-default-bg-color); + color: var(--md-default-fg-color); + box-shadow: var(--md-shadow-z2); + font-size: 0.5rem; + font-weight: 600; + line-height: 1.4; + white-space: normal; + pointer-events: none; + opacity: 0; + visibility: hidden; + transform: translate(-50%, 5px); + transition: + opacity 250ms ease, + transform 250ms ease, + visibility 250ms ease; +} + +.github-release a[data-tooltip]:hover::after, +.github-release a[data-tooltip]:focus-visible::after { + opacity: 1; + visibility: visible; + transform: translate(-50%, 0); +} + +/* Release header */ + +.github-release__header { + display: flex; + justify-content: space-between; + align-items: baseline; + gap: 1rem; +} + +.github-release__header h1 { + margin-bottom: 0; +} + +.github-release__date_header { + flex-shrink: 0; + color: var(--md-default-fg-color--light); +} + .github-release__metadata { - display: inline-flex; + display: flex; align-items: center; + justify-content: space-between; gap: 1rem; - font-size: 0.8rem; - margin-bottom: 0rem; + margin: 0 0 1.5rem; + font-size: 0.75rem; + color: var(--md-default-fg-color--light); } -.github-release__date, -.github-release__immutable, -.github-release__tag { - display: inline-flex; - align-items: center; - gap: 0.25rem; +.github-release__author { + min-width: 0; } -.github-release__body { - margin-top: 0rem; +.github-release__link { + flex-shrink: 0; + font-weight: 500; +} + +@media screen and (max-width: 600px) { + .github-release__metadata { + flex-wrap: wrap; + } +} + +.github-release__badge { + display: inline-block; + padding: 0.2rem 0.4rem; + border: 1px solid var(--color-success); + border-radius: 0.7rem; + margin-left: 0.3rem; + font-size: 0.55rem; + font-weight: 550; + line-height: 1.4; + vertical-align: middle; + color: var(--color-success); +} + +/* Custom admonition */ +:root { + --md-admonition-icon--caution: url('data:image/svg+xml;charset=utf-8,') +} +.github-release__body .admonition.caution, +.github-release__body details.caution { + border-color: rgb(255, 23, 68); +} + +.github-release__body .caution > .admonition-title, +.github-release__body .caution > summary { + background-color: rgba(255, 23, 68, 0.1); +} + +.github-release__body .caution > .admonition-title::before, +.github-release__body .caution > summary::before { + background-color: rgb(255, 23, 68); + -webkit-mask-image: var(--md-admonition-icon--caution); + mask-image: var(--md-admonition-icon--caution); } .highlight .go::before { @@ -534,6 +660,7 @@ html { .md-tooltip { border-radius: 0.5rem; + font-weight: 600; } /* MDX Badge */ From 83619af9e7070b877fd50cc5d4ff9677d8258881 Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Mon, 19 Oct 2026 00:07:23 +0700 Subject: [PATCH 18/37] docs: Move documentation deployment to Cloudflare Workers (#183) --- .github/workflows/documentation-preview.yml | 58 ---------- .github/workflows/documentation.yml | 37 ------ CONTRIBUTING.md | 2 +- README.md | 4 +- docs/llms.txt | 118 ++++++++++---------- docs/overrides/main.html | 40 ++++--- docs/robots.txt | 2 +- mkdocs.yml | 4 +- pyproject.toml | 2 +- 9 files changed, 90 insertions(+), 177 deletions(-) delete mode 100644 .github/workflows/documentation-preview.yml delete mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation-preview.yml b/.github/workflows/documentation-preview.yml deleted file mode 100644 index c6370736..00000000 --- a/.github/workflows/documentation-preview.yml +++ /dev/null @@ -1,58 +0,0 @@ -name: Documentation Preview - -on: - pull_request: - types: - - opened - - synchronize - - reopened - - closed - paths: - - "docs/**" - - "onvif/**" - - "mkdocs.yml" - - "pyproject.toml" - -permissions: - contents: write - pull-requests: write - -concurrency: - group: preview-${{ github.event.pull_request.number }} - cancel-in-progress: true - -jobs: - preview: - - runs-on: ubuntu-latest - - steps: - - name: Checkout - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 - with: - fetch-depth: 0 - - - name: Set up Python - if: github.event.action != 'closed' - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 - with: - python-version: "3.12" - - - name: Install documentation dependencies - if: github.event.action != 'closed' - run: | - python -m pip install --upgrade pip - pip install -e ".[docs]" - - - name: Build documentation - if: github.event.action != 'closed' - run: | - mkdocs build --strict - - - name: Deploy PR preview - uses: rossjrw/pr-preview-action@ffa7509e91a3ec8dfc2e5536c4d5c1acdf7a6de9 # v1.8.1 - with: - source-dir: site/ - preview-branch: gh-pages - umbrella-dir: pr-preview - wait-for-pages-deployment: true \ No newline at end of file diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml deleted file mode 100644 index 24dc03f2..00000000 --- a/.github/workflows/documentation.yml +++ /dev/null @@ -1,37 +0,0 @@ -name: Documentation - -on: - push: - branches: - - main - paths: - - "docs/**" - - "onvif/**" - - "mkdocs.yml" - - "pyproject.toml" - workflow_dispatch: - -permissions: - contents: write - -jobs: - deploy: - - runs-on: ubuntu-latest - - steps: - - name: Checkout - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 - - - name: Set up Python - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 - with: - python-version: "3.x" - - - name: Install documentation dependencies - run: | - python -m pip install --upgrade pip - pip install ".[docs]" - - - name: Deploy documentation - run: mkdocs gh-deploy --force \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 924124e1..87921378 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,4 +12,4 @@ Your feedback, code, documentation, and ideas help make this project better for ## How to contribute? -Please check the [Contributing](https://nirsimetri.github.io/onvif-python/project/contributing) guide page, that page explains step-by-step how to contribute to the project correctly. \ No newline at end of file +Please check the [Contributing Guide](https://onvif-python.nirsimetri.workers.dev/project/contributing) page, that page explains step-by-step how to contribute to the project correctly. \ No newline at end of file diff --git a/README.md b/README.md index 53a3cf72..803bd801 100644 --- a/README.md +++ b/README.md @@ -103,14 +103,14 @@ cd onvif-python pip install . ``` -Once the installation is successful, you can also immediately access the [ONVIF CLI](https://nirsimetri.github.io/onvif-python/core/onvif_cli/) via the terminal using: +Once the installation is successful, you can also immediately access the [ONVIF CLI](https://onvif-python.nirsimetri.workers.dev/core/onvif_cli/) via the terminal using: ```shell onvif --help ``` ## Documentation -For complete guide, including usage examples and API references, please visit the [Documentation Page](https://nirsimetri.github.io/onvif-python/). +For complete guide, including usage examples and API references, please visit the [Documentation Site](https://onvif-python.nirsimetri.workers.dev/). ## License diff --git a/docs/llms.txt b/docs/llms.txt index e31bf166..1dd37de8 100644 --- a/docs/llms.txt +++ b/docs/llms.txt @@ -6,7 +6,7 @@ ONVIF Python is an independent open-source implementation of the ONVIF specifica The library uses Zeep for SOAP communication and Requests for HTTP transport. It aims to preserve official ONVIF operation names, parameter structures, and response formats while providing type hints, IDE completion, connection configuration, caching, error handling, and debugging facilities. -- Official documentation: https://nirsimetri.github.io/onvif-python +- Official documentation: https://onvif-python.nirsimetri.workers.dev - GitHub repository: https://github.com/nirsimetri/onvif-python - PyPI package: https://pypi.org/project/onvif-python - Python requirement: 3.10 or higher @@ -14,15 +14,15 @@ The library uses Zeep for SOAP communication and Requests for HTTP transport. It ## Getting Started -- [Installation](https://nirsimetri.github.io/onvif-python/installation/): Install the package using pip, pipx, or a local repository checkout. -- [Quickstart](https://nirsimetri.github.io/onvif-python/quick_start/): Discover ONVIF devices, initialize `ONVIFClient`, create service instances, retrieve device information, and obtain RTSP stream URIs. -- [Philosophy](https://nirsimetri.github.io/onvif-python/philosophy/): Understand the library's design principles, WYSIWYG API approach, interoperability goals, specification accuracy, Python typing, and dependency philosophy. +- [Installation](https://onvif-python.nirsimetri.workers.dev/installation/): Install the package using pip, pipx, or a local repository checkout. +- [Quickstart](https://onvif-python.nirsimetri.workers.dev/quick_start/): Discover ONVIF devices, initialize `ONVIFClient`, create service instances, retrieve device information, and obtain RTSP stream URIs. +- [Philosophy](https://onvif-python.nirsimetri.workers.dev/philosophy/): Understand the library's design principles, WYSIWYG API approach, interoperability goals, specification accuracy, Python typing, and dependency philosophy. ## Main Features -- [ONVIF Client Guide](https://nirsimetri.github.io/onvif-python/main/onvif_client/): Configure connections, authentication, HTTPS, timeouts, WSDL directories, Zeep plugins, caching modes, and XML debugging. -- [CLI Guide](https://nirsimetri.github.io/onvif-python/main/onvif_cli/): Discover devices, execute service operations, use the interactive shell, inspect services, search the ONVIF product database, and export command output. -- [Helper Methods](https://nirsimetri.github.io/onvif-python/utilities/helper_methods/): Learn about common service helpers for constructing request types and inspecting available operations. +- [ONVIF Client Guide](https://onvif-python.nirsimetri.workers.dev/main/onvif_client/): Configure connections, authentication, HTTPS, timeouts, WSDL directories, Zeep plugins, caching modes, and XML debugging. +- [CLI Guide](https://onvif-python.nirsimetri.workers.dev/main/onvif_cli/): Discover devices, execute service operations, use the interactive shell, inspect services, search the ONVIF product database, and export command output. +- [Helper Methods](https://onvif-python.nirsimetri.workers.dev/utilities/helper_methods/): Learn about common service helpers for constructing request types and inspecting available operations. ## API Reference @@ -30,85 +30,85 @@ The API reference is generated from the library's Python source code. Use it to ### Core -- [API Reference Overview](https://nirsimetri.github.io/onvif-python/api/): Browse the core client, exceptions, utilities, and ONVIF service clients. -- [ONVIFClient](https://nirsimetri.github.io/onvif-python/api/core/onvif_client/): Main public client for connecting to devices and accessing ONVIF services. -- [ONVIFOperator](https://nirsimetri.github.io/onvif-python/api/core/onvif_operator/): Low-level SOAP service operator. Should use `ONVIFClient` for normal application development. +- [API Reference Overview](https://onvif-python.nirsimetri.workers.dev/api/): Browse the core client, exceptions, utilities, and ONVIF service clients. +- [ONVIFClient](https://onvif-python.nirsimetri.workers.dev/api/core/onvif_client/): Main public client for connecting to devices and accessing ONVIF services. +- [ONVIFOperator](https://onvif-python.nirsimetri.workers.dev/api/core/onvif_operator/): Low-level SOAP service operator. Should use `ONVIFClient` for normal application development. ### Exceptions -- [ONVIFOperationException](https://nirsimetri.github.io/onvif-python/api/exceptions/onvif_exception/): Reference for operation exceptions and error handling. -- [Error Handlers](https://nirsimetri.github.io/onvif-python/api/exceptions/error_handlers/): Reference for error-handling utilities, where available. +- [ONVIFOperationException](https://onvif-python.nirsimetri.workers.dev/api/exceptions/onvif_exception/): Reference for operation exceptions and error handling. +- [Error Handlers](https://onvif-python.nirsimetri.workers.dev/api/exceptions/error_handlers/): Reference for error-handling utilities, where available. ### Utilities -- [ONVIFDiscovery](https://nirsimetri.github.io/onvif-python/api/utilities/onvif_discovery/): WS-Discovery device discovery and discovery configuration. -- [CacheMode](https://nirsimetri.github.io/onvif-python/api/utilities/cache_mode/): Cache mode configuration. -- [ONVIFWSDL](https://nirsimetri.github.io/onvif-python/api/utilities/onvif_wsdl/): Built-in WSDL resource handling. -- [ONVIFService](https://nirsimetri.github.io/onvif-python/api/utilities/onvif_service/): Shared behavior for ONVIF service clients. -- [ZeepPatcher](https://nirsimetri.github.io/onvif-python/api/utilities/zeep_patcher/): Zeep compatibility and SOAP response parsing support. -- [Plugins](https://nirsimetri.github.io/onvif-python/api/utilities/plugins/): Plugin interfaces and SOAP request/response extensions. +- [ONVIFDiscovery](https://onvif-python.nirsimetri.workers.dev/api/utilities/onvif_discovery/): WS-Discovery device discovery and discovery configuration. +- [CacheMode](https://onvif-python.nirsimetri.workers.dev/api/utilities/cache_mode/): Cache mode configuration. +- [ONVIFWSDL](https://onvif-python.nirsimetri.workers.dev/api/utilities/onvif_wsdl/): Built-in WSDL resource handling. +- [ONVIFService](https://onvif-python.nirsimetri.workers.dev/api/utilities/onvif_service/): Shared behavior for ONVIF service clients. +- [ZeepPatcher](https://onvif-python.nirsimetri.workers.dev/api/utilities/zeep_patcher/): Zeep compatibility and SOAP response parsing support. +- [Plugins](https://onvif-python.nirsimetri.workers.dev/api/utilities/plugins/): Plugin interfaces and SOAP request/response extensions. ### ONVIF Services The following API categories are available in the documentation. Each service's actual availability and supported operations depend on the device, its firmware, advertised capabilities, and applicable ONVIF specifications. -- [Device](https://nirsimetri.github.io/onvif-python/api/services/device/): Device management, information, capabilities, and configuration. -- [Events](https://nirsimetri.github.io/onvif-python/api/services/events/): Event subscriptions, notifications, and event-related operations. -- [Imaging](https://nirsimetri.github.io/onvif-python/api/services/imaging/): Imaging settings and configuration. -- [Media](https://nirsimetri.github.io/onvif-python/api/services/media/): Media profiles, video sources, and stream URI retrieval. -- [Media2](https://nirsimetri.github.io/onvif-python/api/services/media2/): Media2 service operations. -- [PTZ](https://nirsimetri.github.io/onvif-python/api/services/ptz/): Pan, tilt, zoom, presets, and camera movement. -- [Provisioning](https://nirsimetri.github.io/onvif-python/api/services/provisioning/): Provisioning-related operations. -- [DeviceIO](https://nirsimetri.github.io/onvif-python/api/services/device_io/): Device input/output operations. -- [Display](https://nirsimetri.github.io/onvif-python/api/services/display/): Display service operations. -- [Thermal](https://nirsimetri.github.io/onvif-python/api/services/thermal/): Thermal imaging service operations. -- [Analytics](https://nirsimetri.github.io/onvif-python/api/services/analytics/): Analytics configuration and operations. -- [AnalyticsDevice](https://nirsimetri.github.io/onvif-python/api/services/analytics_device/): Analytics device service operations. -- [Receiver](https://nirsimetri.github.io/onvif-python/api/services/receiver/): Receiver service operations. -- [Recording](https://nirsimetri.github.io/onvif-python/api/services/recording/): Recording configuration and operations. -- [Search](https://nirsimetri.github.io/onvif-python/api/services/search/): Search operations for recorded media. -- [Replay](https://nirsimetri.github.io/onvif-python/api/services/replay/): Replay service operations. -- [ActionEngine](https://nirsimetri.github.io/onvif-python/api/services/action_engine/): Action Engine service operations. -- [Schedule](https://nirsimetri.github.io/onvif-python/api/services/schedule/): Scheduling service operations. -- [AccessControl](https://nirsimetri.github.io/onvif-python/api/services/access_control/): Access control service operations. -- [DoorControl](https://nirsimetri.github.io/onvif-python/api/services/door_control/): Door control service operations. -- [AccessRules](https://nirsimetri.github.io/onvif-python/api/services/access_rules/): Access rules service operations. -- [AuthenticationBehavior](https://nirsimetri.github.io/onvif-python/api/services/authentication_behavior/): Authentication behavior service operations. -- [Credential](https://nirsimetri.github.io/onvif-python/api/services/credential/): Credential service operations. -- [Security](https://nirsimetri.github.io/onvif-python/api/services/security/): Security service operations. -- [AppManagement](https://nirsimetri.github.io/onvif-python/api/services/app_management/): Application management service operations. -- [Uplink](https://nirsimetri.github.io/onvif-python/api/services/uplink/): Uplink service operations. - -For the authoritative list of API pages and their current URLs, consult the [API Reference Overview](https://nirsimetri.github.io/onvif-python/api/). +- [Device](https://onvif-python.nirsimetri.workers.dev/api/services/device/): Device management, information, capabilities, and configuration. +- [Events](https://onvif-python.nirsimetri.workers.dev/api/services/events/): Event subscriptions, notifications, and event-related operations. +- [Imaging](https://onvif-python.nirsimetri.workers.dev/api/services/imaging/): Imaging settings and configuration. +- [Media](https://onvif-python.nirsimetri.workers.dev/api/services/media/): Media profiles, video sources, and stream URI retrieval. +- [Media2](https://onvif-python.nirsimetri.workers.dev/api/services/media2/): Media2 service operations. +- [PTZ](https://onvif-python.nirsimetri.workers.dev/api/services/ptz/): Pan, tilt, zoom, presets, and camera movement. +- [Provisioning](https://onvif-python.nirsimetri.workers.dev/api/services/provisioning/): Provisioning-related operations. +- [DeviceIO](https://onvif-python.nirsimetri.workers.dev/api/services/device_io/): Device input/output operations. +- [Display](https://onvif-python.nirsimetri.workers.dev/api/services/display/): Display service operations. +- [Thermal](https://onvif-python.nirsimetri.workers.dev/api/services/thermal/): Thermal imaging service operations. +- [Analytics](https://onvif-python.nirsimetri.workers.dev/api/services/analytics/): Analytics configuration and operations. +- [AnalyticsDevice](https://onvif-python.nirsimetri.workers.dev/api/services/analytics_device/): Analytics device service operations. +- [Receiver](https://onvif-python.nirsimetri.workers.dev/api/services/receiver/): Receiver service operations. +- [Recording](https://onvif-python.nirsimetri.workers.dev/api/services/recording/): Recording configuration and operations. +- [Search](https://onvif-python.nirsimetri.workers.dev/api/services/search/): Search operations for recorded media. +- [Replay](https://onvif-python.nirsimetri.workers.dev/api/services/replay/): Replay service operations. +- [ActionEngine](https://onvif-python.nirsimetri.workers.dev/api/services/action_engine/): Action Engine service operations. +- [Schedule](https://onvif-python.nirsimetri.workers.dev/api/services/schedule/): Scheduling service operations. +- [AccessControl](https://onvif-python.nirsimetri.workers.dev/api/services/access_control/): Access control service operations. +- [DoorControl](https://onvif-python.nirsimetri.workers.dev/api/services/door_control/): Door control service operations. +- [AccessRules](https://onvif-python.nirsimetri.workers.dev/api/services/access_rules/): Access rules service operations. +- [AuthenticationBehavior](https://onvif-python.nirsimetri.workers.dev/api/services/authentication_behavior/): Authentication behavior service operations. +- [Credential](https://onvif-python.nirsimetri.workers.dev/api/services/credential/): Credential service operations. +- [Security](https://onvif-python.nirsimetri.workers.dev/api/services/security/): Security service operations. +- [AppManagement](https://onvif-python.nirsimetri.workers.dev/api/services/app_management/): Application management service operations. +- [Uplink](https://onvif-python.nirsimetri.workers.dev/api/services/uplink/): Uplink service operations. + +For the authoritative list of API pages and their current URLs, consult the [API Reference Overview](https://onvif-python.nirsimetri.workers.dev/api/). ## ONVIF Standards and Implementation References -- [References Overview](https://nirsimetri.github.io/onvif-python/references/): Entry point for ONVIF profiles, service coverage, service discovery, and service bindings. -- [Supported Profiles](https://nirsimetri.github.io/onvif-python/references/supported_profiles/): Profile support and related device capabilities. -- [Implementation Coverage](https://nirsimetri.github.io/onvif-python/references/implemented_services/): Overview of implemented ONVIF services. -- [Service Discovery](https://nirsimetri.github.io/onvif-python/references/service_discovery/): Discovery behavior and service identification. -- [Service Bindings](https://nirsimetri.github.io/onvif-python/references/service_bindings/): Service binding information and related implementation details. +- [References Overview](https://onvif-python.nirsimetri.workers.dev/references/): Entry point for ONVIF profiles, service coverage, service discovery, and service bindings. +- [Supported Profiles](https://onvif-python.nirsimetri.workers.dev/references/supported_profiles/): Profile support and related device capabilities. +- [Implementation Coverage](https://onvif-python.nirsimetri.workers.dev/references/implemented_services/): Overview of implemented ONVIF services. +- [Service Discovery](https://onvif-python.nirsimetri.workers.dev/references/service_discovery/): Discovery behavior and service identification. +- [Service Bindings](https://onvif-python.nirsimetri.workers.dev/references/service_bindings/): Service binding information and related implementation details. - [Official ONVIF Website](https://www.onvif.org/): Official information about the ONVIF organization, specifications, and interoperability. - [ONVIF Profiles](https://www.onvif.org/profiles/): Official profile information. ## Project and Development -- [Contributing](https://nirsimetri.github.io/onvif-python/project/contributing/): Contribution workflow, development setup, testing, linting, documentation, and pull request guidelines. -- [Roadmap](https://nirsimetri.github.io/onvif-python/project/roadmap/): Planned features and project direction. -- [Used By](https://nirsimetri.github.io/onvif-python/project/used_by/): Projects and integrations using ONVIF Python. -- [External Resources](https://nirsimetri.github.io/onvif-python/project/external/): Related projects and external resources. +- [Contributing](https://onvif-python.nirsimetri.workers.dev/project/contributing/): Contribution workflow, development setup, testing, linting, documentation, and pull request guidelines. +- [Roadmap](https://onvif-python.nirsimetri.workers.dev/project/roadmap/): Planned features and project direction. +- [Used By](https://onvif-python.nirsimetri.workers.dev/project/used_by/): Projects and integrations using ONVIF Python. +- [External Resources](https://onvif-python.nirsimetri.workers.dev/project/external/): Related projects and external resources. - [GitHub Repository](https://github.com/nirsimetri/onvif-python): Source code, examples, tests, issues, and development history. - [Examples](https://github.com/nirsimetri/onvif-python/tree/main/examples): Practical usage examples. - [Tests](https://github.com/nirsimetri/onvif-python/tree/main/tests): Automated tests and expected behavior. -- [Releases](https://nirsimetri.github.io/onvif-python/releases/): Project release history and release notes. +- [Releases](https://onvif-python.nirsimetri.workers.dev/releases/): Project release history and release notes. - [GitHub Releases](https://github.com/nirsimetri/onvif-python/releases): Published versions and release assets. - [Issues](https://github.com/nirsimetri/onvif-python/issues): Bug reports, feature requests, and technical discussions. ## Legal -- [Legal Overview](https://nirsimetri.github.io/onvif-python/legal/): Legal notices and licensing information. -- [Notice](https://nirsimetri.github.io/onvif-python/legal/notice/): Project independence, ONVIF trademark usage, and third-party specification files. -- [License](https://nirsimetri.github.io/onvif-python/legal/license/): License information. +- [Legal Overview](https://onvif-python.nirsimetri.workers.dev/legal/): Legal notices and licensing information. +- [Notice](https://onvif-python.nirsimetri.workers.dev/legal/notice/): Project independence, ONVIF trademark usage, and third-party specification files. +- [License](https://onvif-python.nirsimetri.workers.dev/legal/license/): License information. ## Installation and Usage Notes diff --git a/docs/overrides/main.html b/docs/overrides/main.html index b356c319..135285f6 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -1,6 +1,8 @@ {% extends "base.html" %} {% block extrahead %} + {{ super() }} + - + {% if config.extra.google_site_verification %} + + {% endif %} - - + + gtag("js", new Date()); + gtag("config", "{{ config.extra.google_analytics_id }}"); + + {% endif %} {% endblock %} \ No newline at end of file diff --git a/docs/robots.txt b/docs/robots.txt index ff8ef0df..280c9b81 100644 --- a/docs/robots.txt +++ b/docs/robots.txt @@ -1,4 +1,4 @@ User-agent: * Allow: / -Sitemap: https://nirsimetri.github.io/onvif-python/sitemap.xml \ No newline at end of file +Sitemap: https://onvif-python.nirsimetri.workers.dev/sitemap.xml \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index a417ae63..d86b10fc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,7 @@ site_name: ONVIF Python site_description: >- A modern Python library for ONVIF-compliant IP cameras and devices, providing a clean, typed API for discovery, device management, media, PTZ, and events. -site_url: https://nirsimetri.github.io/onvif-python/ +site_url: !ENV [SITE_URL, 'https://onvif-python.nirsimetri.workers.dev/'] repo_url: https://github.com/nirsimetri/onvif-python repo_name: nirsimetri/onvif-python edit_uri: edit/dev/docs/ @@ -240,6 +240,8 @@ validation: extra: generator: false + google_site_verification: !ENV [GOOGLE_SITE_VERIFICATION, ""] + google_analytics_id: !ENV [GOOGLE_ANALYTICS_PROPERTY, ""] social: - icon: fontawesome/solid/globe link: https://nirsimetri.com diff --git a/pyproject.toml b/pyproject.toml index 73fcb82d..f27b9790 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -55,7 +55,7 @@ dependencies = [ [project.urls] Homepage = "https://github.com/nirsimetri/onvif-python" -Documentation = "https://nirsimetri.github.io/onvif-python" +Documentation = "https://onvif-python.nirsimetri.workers.dev" Changelog = "https://github.com/nirsimetri/onvif-python/releases" Issues = "https://github.com/nirsimetri/onvif-python/issues" From 21b53713f1a354785d6064b10b3da87172cd3df2 Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Mon, 19 Oct 2026 00:33:47 +0700 Subject: [PATCH 19/37] feat(docs): Add conventions, abbreviations, and logging page + update navigation and styles (#182) --- docs/conventions.md | 97 +++++++++++ docs/hooks/shortcodes.py | 71 +++++--- docs/includes/abbreviations.md | 79 +++++++++ docs/installation.md | 1 + docs/javascripts/github-releases.js | 3 +- docs/main/onvif_client.md | 16 +- .../.icons/material/deployed-code.svg | 1 + .../overrides/.icons/material/folder-code.svg | 1 + docs/project/contributing.md | 4 +- docs/project/roadmap.md | 8 +- docs/project/used_by.md | 4 + docs/quick_start.md | 4 +- docs/stylesheets/extra.css | 31 ++-- docs/utilities/logging.md | 163 ++++++++++++++++++ mkdocs.yml | 7 +- wrangler.jsonc | 9 + 16 files changed, 448 insertions(+), 51 deletions(-) create mode 100644 docs/conventions.md create mode 100644 docs/includes/abbreviations.md create mode 100644 docs/overrides/.icons/material/deployed-code.svg create mode 100644 docs/overrides/.icons/material/folder-code.svg create mode 100644 docs/utilities/logging.md create mode 100644 wrangler.jsonc diff --git a/docs/conventions.md b/docs/conventions.md new file mode 100644 index 00000000..3d6d85d2 --- /dev/null +++ b/docs/conventions.md @@ -0,0 +1,97 @@ +--- +hide: + - path +comments: true +--- + +This documentation uses a consistent set of badges to identify version requirements, implementation details, feature availability, parameter constraints, and related resources. + +Each badge conveys a specific meaning, helping readers quickly understand the compatibility, behavior, or purpose of a component or operation. Refer to the conventions below for the meaning of each badge and the information it communicates. + +## Version requirements + +### → Package version { data-toc-label="Package version" } + +Indicates the minimum `onvif-python` package version required to use a feature, parameter, class, or operation. The badge links to the corresponding release documentation. + +### → ONVIF version { data-toc-label="ONVIF version" } + +Indicates the minimum ONVIF version required for device compatibility. The badge links to the relevant ONVIF specification. + +## Implementation details + +### → Internal { data-toc-label="Internal" } + +Identifies an internal implementation detail that is not intended for direct public use. + +Internal components may change without following the same compatibility guarantees as the public API. + +### → Entry point { data-toc-label="Entry point" } + +Identifies the entry point of an ONVIF service or operation, helping readers locate where a particular interaction begins. + +### → Exception { data-toc-label="Exception" } + +Identifies an exception type associated with an operation, indicating the kind of error that may be raised. + +### → Error handler { data-toc-label="Error handler" } + +Identifies a function or mechanism responsible for handling errors during an operation. + +## Features and extensions + +### → Plugin { data-toc-label="Plugin" } + +A [Zeep plugin](https://docs.python-zeep.org/en/master/plugins.html) that intercepts and processes SOAP messages exchanged by the client. + +### → Utility { data-toc-label="Utility" } + +Identifies a supporting utility that provides reusable functionality for common tasks. + +### → Feature { data-toc-label="Feature" } + +Indicates an optional feature that provides additional functionality or behavior. Availability may depend on configuration, device capabilities, or the operation being performed. + +### → Experimental { data-toc-label="Experimental" } + +Marks a feature that is experimental and may undergo changes in behavior, implementation, or API before becoming stable. + +## Examples and references + +### → Example view { data-toc-label="Example view" } + +Links directly to the example source code for inspection. + +### → Example file { data-toc-label="Example file" } + +Links to the example file so readers can inspect or download it. + +### → Module { data-toc-label="Module" } + +Links to the corresponding Python module in the repository, allowing readers to inspect its implementation. + +### → Demo { data-toc-label="Demo" } + +Links to an external repository containing a demonstration or related implementation. + +## Parameters and properties + +### → Default value { data-toc-label="Default value" } + +Displays the default value of a parameter, setting, or property when no explicit value is provided. + +#### → Empty default { data-toc-label="Empty default" } + +Indicates that the default value is `None`, meaning no value is assigned by default. + +#### → Computed default { data-toc-label="Computed default" } + +Indicates that the default value is computed dynamically at runtime rather than being a fixed, explicitly defined value. + +### → Required { data-toc-label="Required" } + +Indicates that a parameter, value, or property is required for the relevant operation or configuration. + +### → Metadata { data-toc-label="Metadata" } + +Identifies a property that provides metadata about a component, object, or resource. \ No newline at end of file diff --git a/docs/hooks/shortcodes.py b/docs/hooks/shortcodes.py index 2c78b421..97463fcd 100644 --- a/docs/hooks/shortcodes.py +++ b/docs/hooks/shortcodes.py @@ -34,6 +34,7 @@ import posixpath import re from re import Match +from urllib.parse import urlparse from mkdocs.config.defaults import MkDocsConfig from mkdocs.structure.files import File, Files @@ -48,7 +49,7 @@ EXAMPLE_PATH = "blob/main/examples" MODULE_PATH = "blob/main/onvif" -ICON_FOR_VERSION = "material-source-pull" +ICON_FOR_VERSION = "material-deployed-code" ICON_FOR_ONVIF_VERSION = "material-app-badging" ICON_FOR_INTERNAL = "material-lock-outline" ICON_FOR_EXCEPTION = "material-alert-circle-outline" @@ -58,8 +59,8 @@ ICON_FOR_PLUGIN = "material-puzzle-outline" ICON_FOR_UTILITY = "material-hammer-wrench" ICON_FOR_EXAMPLE_VIEW = "material-file-eye" -ICON_FOR_EXAMPLE_FILE = "material-file-code" -ICON_FOR_MODULE = "material-code-block-tags" +ICON_FOR_EXAMPLE_FILE = "material-file-download" +ICON_FOR_MODULE = "material-folder-code" ICON_FOR_DEMO = "material-github" ICON_FOR_DEFAULT_VALUE = "material-water" ICON_FOR_DEFAULT_NONE = "material-water-outline" @@ -140,8 +141,6 @@ def replace(match: Match, page: Page | None = None, files: Files | None = None): return _badge_for_plugin(args, page, files) case "utility": return _badge_for_utility(args, page, files) - case "example": - return _badge_for_example(args, page, files) case "example_view": return _badge_for_example_view(args, page, files) case "example_file": @@ -237,7 +236,7 @@ def _badge_for_version(text: str, page: Page | None = None, files: Files | None return _badge( icon=f":{ICON_FOR_VERSION}:", - text=f"[`v{text}`]({href})" if text else "", + text=f"[`{text}`]({href})" if text else "", title="Minimum package version", ) @@ -322,55 +321,81 @@ def _badge_for_utility(text: str, page: Page, files: Files): ) -# Create badge for example -def _badge_for_example(text: str, page: Page, files: Files): - return "\n".join( - [ - _badge_for_example_file(text, page, files), - _badge_for_example_view(text, page, files), - ] - ) +# Parse badge modifier +def _parse_badge_type(text: str): + parts = text.split() + args = [part for part in parts if "=" not in part] + options = dict(part.split("=", 1) for part in parts if "=" in part) + + badge_type = options.get("type", "right") + if badge_type == "default": + badge_type = "" + + return " ".join(args), badge_type # Create badge for example view def _badge_for_example_view(text: str, page: Page, files: Files): + text, badge_type = _parse_badge_type(text) href = f"{REPOSITORY}/{EXAMPLE_PATH}/{text}" + return _badge( icon=f"[:{ICON_FOR_EXAMPLE_VIEW}:]({href}){{.no-external-icon }}", title=f"View example `{text}`", - type="right", + type=badge_type, ) # Create badge for example download def _badge_for_example_file(text: str, page: Page, files: Files): + text, badge_type = _parse_badge_type(text) href = f"{REPOSITORY}/{EXAMPLE_PATH}/{text}" + + download_path = EXAMPLE_PATH.removeprefix("blob/main/") + + download_url = ( + f"https://raw.githubusercontent.com/" + f"{urlparse(REPOSITORY).path.strip('/')}/" + f"refs/heads/main/{download_path}/{text}" + ) + return _badge( - icon=f"[:{ICON_FOR_EXAMPLE_FILE}:]({href}){{.no-external-icon }}", - title="Inspect example file", + icon=f"[:{ICON_FOR_EXAMPLE_FILE}:]({download_url}){{.no-external-icon }}", + title="Download example file", text=f"[`{text}`]({href})", - type="right", + type=badge_type, ) # Create badge for module def _badge_for_module(text: str, page: Page, files: Files): + text, badge_type = _parse_badge_type(text) href = f"{REPOSITORY}/{MODULE_PATH}/{text}" + return _badge( icon=f"[:{ICON_FOR_MODULE}:]({href}){{.no-external-icon }}", title=f"Inspect module `{text}`", - type="right", + type=badge_type, ) # Create badge for demo repository def _badge_for_demo(text: str, page: Page, files: Files): - href = text + href, badge_type = _parse_badge_type(text) + + repo = "" + if href: + path = urlparse(href).path.strip("/") + parts = path.split("/") + + if len(parts) >= 2: + repo = "/".join(parts[:2]) + return _badge( - icon=f"[:{ICON_FOR_DEMO}:]({href})", + icon=f"[:{ICON_FOR_DEMO}:]({href}){{.no-external-icon }}" if href else "", + text=f"[{repo}]({href})", title="Go to repository", - text=f"*{text}*" if text else "", - type="right", + type=badge_type, ) diff --git a/docs/includes/abbreviations.md b/docs/includes/abbreviations.md new file mode 100644 index 00000000..a8c4291d --- /dev/null +++ b/docs/includes/abbreviations.md @@ -0,0 +1,79 @@ +*[OASIS]: Organization for the Advancement of Structured Information Standards +*[IEEE]: Institute of Electrical and Electronics Engineers +*[RFC]: Request for Comments +*[PKCS]: Public Key Cryptography Standards + +*[API]: Application Programming Interface +*[SOAP]: Simple Object Access Protocol +*[REST]: Representational State Transfer +*[XML]: Extensible Markup Language +*[XAddr]: Endpoint Address +*[XAddrs]: Endpoint Addresses +*[WSDL]: Web Services Description Language +*[XSD]: XML Schema Definition +*[HTTP]: Hypertext Transfer Protocol +*[HTTPS]: Hypertext Transfer Protocol Secure + +*[WS-Discovery]: Web Services Dynamic Discovery +*[WS-Security]: Web Services Security +*[WS-UsernameToken]: Web Services Security UsernameToken +*[WS-Addressing]: Web Services Addressing +*[WS-BaseNotification]: Web Services Base Notification + +*[IP]: Internet Protocol +*[IPv4]: Internet Protocol Version 4 +*[IPv6]: Internet Protocol Version 6 +*[TTL]: Time To Live +*[TLS]: Transport Layer Security +*[SSL]: Secure Socket Layer +*[Unicast]: One-to-One +*[Multicast]: One-to-Many +*[RTSP]: Real-Time Streaming Protocol +*[RTP]: Real-time Transport Protocol +*[SRTP]: Secure Real-time Transport Protocol +*[TCP]: Transmission Control Protocol +*[UDP]: User Datagram Protocol +*[DHCP]: Dynamic Host Configuration Protocol +*[NTP]: Network Time Protocol +*[DNS]: Domain Name System + +*[ID]: Identifier +*[IDs]: Identifiers +*[URI]: Uniform Resource Identifier +*[URL]: Uniform Resource Locator +*[URLs]: Uniform Resource Locators +*[UUID]: Universally Unique Identifier +*[UTC]: Coordinated Universal Time +*[JWT]: JSON Web Token +*[RSA]: Rivest–Shamir–Adleman +*[ECC]: Elliptic Curve Cryptography +*[DER]: Distinguished Encoding Rules +*[CA]: Certificate Authority +*[CSR]: Certificate Signing Request (also called Certification Request) +*[CRL]: Certificate Revocation List +*[CRLs]: Certificate Revocation Lists + +*[EQPreset]: Equalizer Preset +*[DP]: Device Proxy +*[DST]: Daylight Saving Time +*[PTZ]: Pan/Tilt/Zoom +*[OSD]: On-Screen Display +*[TTS]: Text-to-Speech +*[FW]: Firmware + +*[JPEG]: Joint Photographic Experts Group +*[WebRTC]: Web Real-Time Communication + +*[MCS]: Manufacturer Cloud Service +*[ACMS]: Access Control Management System +*[BMS]: Building Management System +*[PACS]: Physical Access Control System +*[PSIM]: Physical Security Information Management +*[REX]: Request-to-Exit +*[VMS]: Video Management System +*[NVC]: Network Video Client +*[NVCs]: Network Video Clients +*[NVT]: Network Video Transmitter +*[NVD]: Network Video Display +*[NVS]: Network Video Storage +*[NVA]: Network Video Analytics \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md index 57c63a5c..8865de59 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,6 +1,7 @@ --- hide: - path +comments: true --- From official [PyPI](https://pypi.org/project/onvif-python/): diff --git a/docs/javascripts/github-releases.js b/docs/javascripts/github-releases.js index 7ad60e91..5841e649 100644 --- a/docs/javascripts/github-releases.js +++ b/docs/javascripts/github-releases.js @@ -1,7 +1,6 @@ /* global DOMPurify, marked, document$, GITHUB_REPOSITORY */ const GITHUB_REPOSITORY = "nirsimetri/onvif-python"; -const [, GITHUB_REPOSITORY_NAME] = GITHUB_REPOSITORY.split("/"); const GITHUB_API = `https://api.github.com/repos/${GITHUB_REPOSITORY}/releases?per_page=100`; const RELEASES_NAV_STATE_KEY = "github-releases-nav-open"; @@ -117,7 +116,7 @@ function createReleaseNav(releases) { const link = document.createElement("a"); link.className = "md-nav__link"; - link.href = `/${GITHUB_REPOSITORY_NAME}/releases/#${encodeURIComponent( + link.href = `/releases/#${encodeURIComponent( release.tag_name )}`; diff --git a/docs/main/onvif_client.md b/docs/main/onvif_client.md index 1bf35271..3dc3e490 100644 --- a/docs/main/onvif_client.md +++ b/docs/main/onvif_client.md @@ -82,7 +82,7 @@ client = ONVIFClient( Set `http_digest` to `True`. -```python linenums="1" +```python linenums="1" hl_lines="9" from onvif import ONVIFClient # Minimal configuration @@ -96,7 +96,7 @@ client = ONVIFClient( ``` #### Secure Connection (HTTPS) -```python linenums="1" +```python linenums="1" hl_lines="10" from onvif import ONVIFClient # Connect via HTTPS with custom timeout @@ -111,7 +111,7 @@ client = ONVIFClient( ``` #### Performance Optimized (Memory Cache) -```python linenums="1" +```python linenums="1" hl_lines="9" from onvif import ONVIFClient, CacheMode # Use memory-only cache for quick scripts @@ -128,7 +128,7 @@ client = ONVIFClient( -```python linenums="1" +```python linenums="1" hl_lines="9 10" from onvif import ONVIFClient, CacheMode # Disable all caching for testing @@ -146,7 +146,7 @@ client = ONVIFClient( -```python linenums="1" +```python linenums="1" hl_lines="9 18 21 24 26 29-31 34-37 40" from onvif import ONVIFClient # Enable XML capture for debugging @@ -196,7 +196,7 @@ if client.xml_plugin: -```python linenums="1" +```python linenums="1" hl_lines="9" from onvif import ONVIFClient # Use custom WSDL files instead of built-in ones @@ -224,7 +224,7 @@ ptz = client.ptz() #### Production Configuration -```python linenums="1" +```python linenums="1" hl_lines="9 11-16" from onvif import ONVIFClient, CacheMode # Recommended production settings @@ -232,7 +232,7 @@ client = ONVIFClient( host="your-cctv-node.viewplexus.com", port=443, username="admin", - password="secure_password", + password="@secure_password88", http_digest=True, # Use HTTP Digest authentiation timeout=15, cache=CacheMode.DB, # Maximum performance (default) diff --git a/docs/overrides/.icons/material/deployed-code.svg b/docs/overrides/.icons/material/deployed-code.svg new file mode 100644 index 00000000..24bee7ec --- /dev/null +++ b/docs/overrides/.icons/material/deployed-code.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/overrides/.icons/material/folder-code.svg b/docs/overrides/.icons/material/folder-code.svg new file mode 100644 index 00000000..873c5e23 --- /dev/null +++ b/docs/overrides/.icons/material/folder-code.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/project/contributing.md b/docs/project/contributing.md index 72066fba..d5de8f59 100644 --- a/docs/project/contributing.md +++ b/docs/project/contributing.md @@ -19,7 +19,7 @@ If you find a bug, please [open an issue](https://github.com/nirsimetri/onvif-py Suggest new features or improvements by opening an issue and describing your use case and desired functionality. ### Code Contributions -Submit fixes, enhancements, or new features via Pull Requests. See [Development Setup](#development-setup) and [Pull Request Guidelines](#pull-request-guidelines). +Submit fixes, enhancements, or new features via Pull Requests. See [Development Setup](#development-setup) and [Pull Request Guide](#pull-request-guide). ### Documentation Help improve the [`docs/`](https://github.com/nirsimetri/onvif-python/tree/dev/docs) source, usage examples, or API documentation. @@ -220,6 +220,7 @@ docs/ ├── javascripts/ ├── stylesheets/ ├── overrides/ +├── includes/ ├── api/ ├── main/ ├── references/ @@ -228,6 +229,7 @@ docs/ ├── legal/ ├── index.md ├── installation.md +├── conventions.md ├── quick_start.md ├── approach.md ├── releases.md diff --git a/docs/project/roadmap.md b/docs/project/roadmap.md index e2ab70fe..369e3014 100644 --- a/docs/project/roadmap.md +++ b/docs/project/roadmap.md @@ -4,11 +4,17 @@ hide: - path --- + + ## Stay tuned and star ⭐ this repo [![GitHub stars](https://img.shields.io/github/stars/nirsimetri/onvif-python?style=social)](https://github.com/nirsimetri/onvif-python){ .no-external-icon } -- [x] Add debugging mode with raw xml on SOAP requests and responses ([`v0.0.6`](../releases.md/#v0.0.6)) +- [x] Add debugging mode with raw XML on SOAP requests and responses ([`v0.0.6`](../releases.md/#v0.0.6)) - [x] Add functionality for `ONVIFClient` to accept a custom `wsdl_dir` ([`v0.1.0`](../releases.md/#v0.1.0)) - [x] Add `ONVIF CLI` program to interact directly with ONVIF devices via terminal ([`v0.1.1`](../releases.md/#v0.1.1)) - [x] Enhance documentation with API references and diagrams (not from [AI Wiki](https://deepwiki.com/nirsimetri/onvif-python)) ([`v0.3.1`](../releases.md/#v0.3.1)) diff --git a/docs/project/used_by.md b/docs/project/used_by.md index 949655e3..487aa244 100644 --- a/docs/project/used_by.md +++ b/docs/project/used_by.md @@ -8,6 +8,8 @@ With ## Viseron + + [Viseron](https://viseron.netlify.app/) is an open-source self-hosted, local only NVR and AI Computer Vision software with support for ONVIF cameras. Viseron @@ -20,6 +22,8 @@ For more information, see the [Viseron ONVIF component](https://viseron.netlify. ## pwneye + + [pwneye](https://github.com/Hackerest/pwneye) is an ONVIF and RTSP camera security testing companion focused on discovering, enumerating, and interacting with real-world security cameras.
+ + {% include ".icons/material/source-pull.svg" %} + + + + + Next Regular Release: December 2026 + + +   /   + + Roadmap → + + + +
+{% endblock %} + {% block extrahead %} {{ super() }} diff --git a/docs/project/roadmap.md b/docs/project/roadmap.md index 369e3014..9114e219 100644 --- a/docs/project/roadmap.md +++ b/docs/project/roadmap.md @@ -1,25 +1,43 @@ --- hide: - - toc - path --- -## Stay tuned and star ⭐ this repo +# Stay tuned and star :star: this repo [![GitHub stars](https://img.shields.io/github/stars/nirsimetri/onvif-python?style=social)](https://github.com/nirsimetri/onvif-python){ .no-external-icon } +!!! info "Release Cycle" + Starting with [`v0.4.5`](../releases.md/#v0.4.5), this library will follow a **quarterly release cycle**, with regular releases **every 3 months**. Bug fixes, documentation, and security updates may be released outside the regular schedule when necessary. + +## Completed - [x] Add debugging mode with raw XML on SOAP requests and responses ([`v0.0.6`](../releases.md/#v0.0.6)) - [x] Add functionality for `ONVIFClient` to accept a custom `wsdl_dir` ([`v0.1.0`](../releases.md/#v0.1.0)) - [x] Add `ONVIF CLI` program to interact directly with ONVIF devices via terminal ([`v0.1.1`](../releases.md/#v0.1.1)) +- [x] Introduce `ONVIFDiscovery` for network device discovery ([`v0.1.6`](../releases.md/#v0.1.6)) +- [x] Add comprehensive logging support to the library ([`v0.2.0`](../releases.md/#v0.2.0)) +- [x] Add `ONVIFParser` for extracting XML element values from SOAP responses ([`v0.2.2`](../releases.md/#v0.2.2)) +- [x] Add support for custom Zeep plugins in `ONVIFClient` initialization ([`v0.2.2`](../releases.md/#v0.2.2)) +- [x] Add support for HTTP Digest authentication and optional credentials ([`v0.3.0`](../releases.md/#v0.3.0)) +- [x] Add service operation docstrings for IDE assistance and API discoverability ([`v0.3.0`](../releases.md/#v0.3.0)) - [x] Enhance documentation with API references and diagrams (not from [AI Wiki](https://deepwiki.com/nirsimetri/onvif-python)) ([`v0.3.1`](../releases.md/#v0.3.1)) -- [ ] Add asynchronous (`async`/`await`) support for non-blocking operations -- [ ] Implement structured data models for ONVIF Schemas using [xsdata](https://github.com/tefra/xsdata) -- [ ] Implement operation tracking based on the device's ONVIF version -- [ ] Add automated comprehensive checks for ONVIF device capabilities -- [ ] Add benchmarking and performance metrics \ No newline at end of file +- [x] Add support for renamed and deprecated ONVIF service operations ([`v0.4.3`](../releases.md/#v0.4.3)) + +## Planned +- [ ] Provide cross-platform standalone CLI binaries via GitHub Actions → (Q4 2026) +- [ ] Add automated comprehensive checks for ONVIF device capabilities → (Q4 2026) +- [ ] Enhance ONVIF product database search results in the CLI → (Q4 2026) +- [ ] Add tutorial blog section to the documentation → (Q4 2026) +- [ ] Add asynchronous (`async`/`await`) support for non-blocking operations → (Q1 2027) +- [ ] Add [ONVIF Client Conformance Testing](https://www.onvif.org/profiles/conformance/client-test/) to the CLI → (Q1 2027) +- [ ] Add benchmarking and performance metrics → (Q1 2027) +- [ ] Implement operation tracking based on the device's ONVIF version → (Q1 2027) +- [ ] Implement structured data models for ONVIF Schemas using [xsdata](https://github.com/tefra/xsdata) → (Q2 2027) +- [ ] Automate operations implementation with official ONVIF specifications → (Q2 2027) +- [ ] Add [ONVIF Device Conformance Testing](https://www.onvif.org/profiles/conformance/device-test-2/) to the CLI → (Q2 2027) \ No newline at end of file diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index c7afa6dc..33b3c22c 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -9,6 +9,8 @@ /* Accent */ --md-accent-fg-color: #005fd3; --md-accent-fg-color--transparent: rgba(0, 51, 153, 0.08); + + --md-text-contrast-color: #ebebeb; } [data-md-color-scheme="slate"] { @@ -22,6 +24,8 @@ /* Accent */ --md-accent-fg-color: #93c5fd; --md-accent-fg-color--transparent: rgba(96, 165, 250, 0.12); + + --md-text-contrast-color: #BBBEC5; } /* Footer — Light */ @@ -284,15 +288,15 @@ } :root { - --color-primary: #0d6efd; + --color-primary: rgb(68, 138, 255); --color-secondary: #6c757d; - --color-success: #198754; - --color-danger: #dc3545; - --color-warning: #ffc107; - --color-info: #0dcaf0; + --color-success: rgb(0, 200, 83); + --color-danger: rgb(245, 0, 87); + --color-warning: rgb(255, 145, 0); + --color-info: rgb(0, 184, 212); --color-light: #f8f9fa; --color-dark: #212529; - --color-muted: #6c757d; + --color-muted: rgb(158, 158, 158); } .success { @@ -720,4 +724,100 @@ html { border-left: 0; border-start-end-radius: 0.25rem; border-end-end-radius: 0.25rem; +} + +/* Release announcement */ +.release-announcement { + display: flex; + align-items: center; + justify-content: start; + flex-wrap: wrap; + gap: 0.5rem; + padding: 0; + font-size: 0.65rem; + line-height: 0.3; + text-align: center; + color: var(--md-accent-fg-color); +} + +.release-announcement__icon { + display: inline-flex; + align-items: center; +} + +.release-announcement__icon svg { + width: 1rem; + height: 1rem; + fill: currentColor; + color: var(--md-text-contrast-color); +} + +.release-announcement__text { + color: var(--md-text-contrast-color); +} + +.release-announcement__link { + display: inline-flex; + align-items: center; + gap: 0.25rem; + font-weight: 500; + color: var(--md-text-contrast-color) !important; + text-decoration: none; + white-space: nowrap; +} + +.release-announcement__link:hover { + text-decoration: underline; + text-underline-offset: 0.2rem; +} + +@media screen and (max-width: 600px) { + .release-announcement { + gap: 0.4rem; + padding: 0.2rem 0; + font-size: 0.55rem; + } +} + +/* Announcement bar */ +.md-banner { + position: relative; + overflow: hidden; + animation: announcement-glow-light 4s ease-in-out infinite; +} + +[data-md-color-scheme="default"] .md-banner { + background-color: #002266; +} +[data-md-color-scheme="slate"] .md-banner { + background-color: #0a1224; +} + +/* Light mode: stronger blue glow */ +@keyframes announcement-glow-light { + 0%, + 100% { + box-shadow: + inset 0 0 10px rgb(96 165 250 / 15%), + 0 0 4px rgb(37 99 235 / 20%); + } + + 50% { + box-shadow: + inset 0 0 28px rgb(96 165 250 / 40%), + 0 0 12px rgb(37 99 235 / 35%); + } +} + +/* Respect reduced-motion preferences */ +@media (prefers-reduced-motion: reduce) { + .md-banner { + animation: none; + } +} + +/* Tasks list */ +.md-typeset [type="checkbox"]:checked + .task-list-indicator::before { + background-color: var(--color-success); + mask-image: var(--md-tasklist-icon--checked); } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 3c9ed695..66f1b418 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,7 +5,7 @@ site_description: >- site_url: !ENV [SITE_URL, 'https://onvif-python.pages.dev/'] repo_url: https://github.com/nirsimetri/onvif-python repo_name: nirsimetri/onvif-python -edit_uri: edit/dev/docs/ +edit_uri: edit/main/docs/ use_directory_urls: true theme: @@ -35,6 +35,7 @@ theme: text: Geist code: Geist Mono features: + - announce.dismiss - content.action.edit - content.action.view - content.code.copy From dc680c83c4c7f3bd25f69917ef16b45255b7492e Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Wed, 21 Oct 2026 00:10:22 +0700 Subject: [PATCH 32/37] feat(docs): Add WSDL generator and input/output schemas to the documentation (#189) * feat(scripts): Add WSDL metadata generator script to JSON files * feat(docs): Add generated schema metadata JSON * feat(docs): Add WSDL schema hooks and jinja templates --- docs/generated/wsdl/schema/common/bw-2.json | 2078 ++ docs/generated/wsdl/schema/common/rw-2.json | 5 + .../ver10/accessrules/wsdl/accessrules.json | 1678 + docs/generated/wsdl/ver10/actionengine.json | 2125 ++ .../wsdl/advancedsecurity.json | 8187 ++++ .../generated/wsdl/ver10/analyticsdevice.json | 9561 +++++ .../wsdl/ver10/appmgmt/wsdl/appmgmt.json | 758 + .../wsdl/authenticationbehavior.json | 3860 ++ .../ver10/credential/wsdl/credential.json | 4916 +++ .../wsdl/ver10/device/wsdl/devicemgmt.json | 16209 ++++++++ docs/generated/wsdl/ver10/deviceio.json | 5283 +++ docs/generated/wsdl/ver10/display.json | 3698 ++ .../generated/wsdl/ver10/display/display.json | 3620 ++ .../wsdl/ver10/events/wsdl/bw-2-vs-mod.json | 2077 ++ .../wsdl/ver10/events/wsdl/event-vs.json | 1509 + .../wsdl/ver10/events/wsdl/event.json | 1509 + .../generated/wsdl/ver10/federatedsearch.json | 11192 ++++++ .../wsdl/ver10/media/wsdl/media.json | 30947 ++++++++++++++++ .../wsdl/ver10/pacs/accesscontrol.json | 4588 +++ .../wsdl/ver10/pacs/doorcontrol.json | 3653 ++ .../ver10/provisioning/wsdl/provisioning.json | 853 + docs/generated/wsdl/ver10/receiver.json | 1645 + docs/generated/wsdl/ver10/recording.json | 6858 ++++ docs/generated/wsdl/ver10/replay.json | 454 + .../wsdl/ver10/schedule/wsdl/schedule.json | 3280 ++ docs/generated/wsdl/ver10/search.json | 4535 +++ .../wsdl/ver10/thermal/wsdl/thermal.json | 1944 + .../wsdl/ver10/uplink/wsdl/uplink.json | 459 + .../wsdl/ver20/analytics/wsdl/analytics.json | 10958 ++++++ .../wsdl/ver20/imaging/wsdl/imaging.json | 4388 +++ .../wsdl/ver20/media/wsdl/media.json | 18116 +++++++++ docs/generated/wsdl/ver20/ptz/wsdl/ptz.json | 10794 ++++++ docs/hooks/griffe_extensions.py | 66 + docs/hooks/wsdl_schema.py | 232 + docs/stylesheets/extra.css | 221 + .../python/material/function.html.jinja | 230 + mkdocs.yml | 4 + scripts/generate_wsdl_metadata.py | 673 + 38 files changed, 183163 insertions(+) create mode 100644 docs/generated/wsdl/schema/common/bw-2.json create mode 100644 docs/generated/wsdl/schema/common/rw-2.json create mode 100644 docs/generated/wsdl/ver10/accessrules/wsdl/accessrules.json create mode 100644 docs/generated/wsdl/ver10/actionengine.json create mode 100644 docs/generated/wsdl/ver10/advancedsecurity/wsdl/advancedsecurity.json create mode 100644 docs/generated/wsdl/ver10/analyticsdevice.json create mode 100644 docs/generated/wsdl/ver10/appmgmt/wsdl/appmgmt.json create mode 100644 docs/generated/wsdl/ver10/authenticationbehavior/wsdl/authenticationbehavior.json create mode 100644 docs/generated/wsdl/ver10/credential/wsdl/credential.json create mode 100644 docs/generated/wsdl/ver10/device/wsdl/devicemgmt.json create mode 100644 docs/generated/wsdl/ver10/deviceio.json create mode 100644 docs/generated/wsdl/ver10/display.json create mode 100644 docs/generated/wsdl/ver10/display/display.json create mode 100644 docs/generated/wsdl/ver10/events/wsdl/bw-2-vs-mod.json create mode 100644 docs/generated/wsdl/ver10/events/wsdl/event-vs.json create mode 100644 docs/generated/wsdl/ver10/events/wsdl/event.json create mode 100644 docs/generated/wsdl/ver10/federatedsearch.json create mode 100644 docs/generated/wsdl/ver10/media/wsdl/media.json create mode 100644 docs/generated/wsdl/ver10/pacs/accesscontrol.json create mode 100644 docs/generated/wsdl/ver10/pacs/doorcontrol.json create mode 100644 docs/generated/wsdl/ver10/provisioning/wsdl/provisioning.json create mode 100644 docs/generated/wsdl/ver10/receiver.json create mode 100644 docs/generated/wsdl/ver10/recording.json create mode 100644 docs/generated/wsdl/ver10/replay.json create mode 100644 docs/generated/wsdl/ver10/schedule/wsdl/schedule.json create mode 100644 docs/generated/wsdl/ver10/search.json create mode 100644 docs/generated/wsdl/ver10/thermal/wsdl/thermal.json create mode 100644 docs/generated/wsdl/ver10/uplink/wsdl/uplink.json create mode 100644 docs/generated/wsdl/ver20/analytics/wsdl/analytics.json create mode 100644 docs/generated/wsdl/ver20/imaging/wsdl/imaging.json create mode 100644 docs/generated/wsdl/ver20/media/wsdl/media.json create mode 100644 docs/generated/wsdl/ver20/ptz/wsdl/ptz.json create mode 100644 docs/hooks/wsdl_schema.py create mode 100644 docs/templates/python/material/function.html.jinja create mode 100644 scripts/generate_wsdl_metadata.py diff --git a/docs/generated/wsdl/schema/common/bw-2.json b/docs/generated/wsdl/schema/common/bw-2.json new file mode 100644 index 00000000..fb99b1d6 --- /dev/null +++ b/docs/generated/wsdl/schema/common/bw-2.json @@ -0,0 +1,2078 @@ +{ + "source": "schema/common/bw-2.wsdl", + "target_namespace": "http://docs.oasis-open.org/wsn/bw-2", + "operations": [ + { + "name": "Notify", + "port_type": "NotificationConsumer", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}Notify", + "parts": [ + { + "name": "Notify", + "element": "{http://docs.oasis-open.org/wsn/b-2}Notify", + "schema": { + "name": "Notify", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NotificationMessage", + "type": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessageHolderType", + "type_name": "NotificationMessageHolderType", + "definition": { + "kind": "complexType", + "name": "NotificationMessageHolderType", + "fields": [ + { + "name": "SubscriptionReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}SubscriptionReference" + }, + { + "name": "Topic", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}Topic" + }, + { + "name": "ProducerReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}ProducerReference" + }, + { + "name": "Message", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessage" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": null, + "parts": [] + }, + "faults": [], + "binding": "NotificationConsumerBinding" + }, + { + "name": "Subscribe", + "port_type": "NotificationProducer", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}SubscribeRequest", + "parts": [ + { + "name": "SubscribeRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}Subscribe", + "schema": { + "name": "Subscribe", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConsumerReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "InitialTerminationTime", + "type": "{http://docs.oasis-open.org/wsn/b-2}AbsoluteOrRelativeTimeType", + "type_name": "AbsoluteOrRelativeTimeType", + "definition": { + "kind": "simpleType", + "name": "AbsoluteOrRelativeTimeType", + "member_types": [ + "{http://www.w3.org/2001/XMLSchema}dateTime", + "{http://www.w3.org/2001/XMLSchema}duration" + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": true + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}SubscribeResponse", + "parts": [ + { + "name": "SubscribeResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}SubscribeResponse", + "schema": { + "name": "SubscribeResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SubscriptionReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "CurrentTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}CurrentTime" + }, + { + "name": "TerminationTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}TerminationTime" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "InvalidFilterFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidFilterFault" + }, + { + "name": "TopicExpressionDialectUnknownFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}TopicExpressionDialectUnknownFault" + }, + { + "name": "InvalidTopicExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidTopicExpressionFault" + }, + { + "name": "TopicNotSupportedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}TopicNotSupportedFault" + }, + { + "name": "InvalidProducerPropertiesExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidProducerPropertiesExpressionFault" + }, + { + "name": "InvalidMessageContentExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidMessageContentExpressionFault" + }, + { + "name": "UnacceptableInitialTerminationTimeFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnacceptableInitialTerminationTimeFault" + }, + { + "name": "UnrecognizedPolicyRequestFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnrecognizedPolicyRequestFault" + }, + { + "name": "UnsupportedPolicyRequestFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsupportedPolicyRequestFault" + }, + { + "name": "NotifyMessageNotSupportedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}NotifyMessageNotSupportedFault" + }, + { + "name": "SubscribeCreationFailedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}SubscribeCreationFailedFault" + } + ], + "binding": "NotificationProducerBinding" + }, + { + "name": "GetCurrentMessage", + "port_type": "NotificationProducer", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}GetCurrentMessageRequest", + "parts": [ + { + "name": "GetCurrentMessageRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}GetCurrentMessage", + "schema": { + "name": "GetCurrentMessage", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Topic", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}GetCurrentMessageResponse", + "parts": [ + { + "name": "GetCurrentMessageResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}GetCurrentMessageResponse", + "schema": { + "name": "GetCurrentMessageResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "TopicExpressionDialectUnknownFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}TopicExpressionDialectUnknownFault" + }, + { + "name": "InvalidTopicExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidTopicExpressionFault" + }, + { + "name": "TopicNotSupportedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}TopicNotSupportedFault" + }, + { + "name": "NoCurrentMessageOnTopicFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}NoCurrentMessageOnTopicFault" + }, + { + "name": "MultipleTopicsSpecifiedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}MultipleTopicsSpecifiedFault" + } + ], + "binding": "NotificationProducerBinding" + }, + { + "name": "GetMessages", + "port_type": "PullPoint", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}GetMessagesRequest", + "parts": [ + { + "name": "GetMessagesRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}GetMessages", + "schema": { + "name": "GetMessages", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "MaximumNumber", + "type": "{http://www.w3.org/2001/XMLSchema}nonNegativeInteger", + "type_name": "nonNegativeInteger", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}GetMessagesResponse", + "parts": [ + { + "name": "GetMessagesResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}GetMessagesResponse", + "schema": { + "name": "GetMessagesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NotificationMessage", + "type": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessageHolderType", + "type_name": "NotificationMessageHolderType", + "definition": { + "kind": "complexType", + "name": "NotificationMessageHolderType", + "fields": [ + { + "name": "SubscriptionReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}SubscriptionReference" + }, + { + "name": "Topic", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}Topic" + }, + { + "name": "ProducerReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}ProducerReference" + }, + { + "name": "Message", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessage" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnableToGetMessagesFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnableToGetMessagesFault" + } + ], + "binding": "PullPointBinding" + }, + { + "name": "DestroyPullPoint", + "port_type": "PullPoint", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}DestroyPullPointRequest", + "parts": [ + { + "name": "DestroyPullPointRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}DestroyPullPoint", + "schema": { + "name": "DestroyPullPoint", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}DestroyPullPointResponse", + "parts": [ + { + "name": "DestroyPullPointResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}DestroyPullPointResponse", + "schema": { + "name": "DestroyPullPointResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnableToDestroyPullPointFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnableToDestroyPullPointFault" + } + ], + "binding": "PullPointBinding" + }, + { + "name": "Notify", + "port_type": "PullPoint", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}Notify", + "parts": [ + { + "name": "Notify", + "element": "{http://docs.oasis-open.org/wsn/b-2}Notify", + "schema": { + "name": "Notify", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NotificationMessage", + "type": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessageHolderType", + "type_name": "NotificationMessageHolderType", + "definition": { + "kind": "complexType", + "name": "NotificationMessageHolderType", + "fields": [ + { + "name": "SubscriptionReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}SubscriptionReference" + }, + { + "name": "Topic", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}Topic" + }, + { + "name": "ProducerReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}ProducerReference" + }, + { + "name": "Message", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessage" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": null, + "parts": [] + }, + "faults": [], + "binding": "PullPointBinding" + }, + { + "name": "CreatePullPoint", + "port_type": "CreatePullPoint", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}CreatePullPointRequest", + "parts": [ + { + "name": "CreatePullPointRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}CreatePullPoint", + "schema": { + "name": "CreatePullPoint", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}CreatePullPointResponse", + "parts": [ + { + "name": "CreatePullPointResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}CreatePullPointResponse", + "schema": { + "name": "CreatePullPointResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PullPoint", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "UnableToCreatePullPointFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnableToCreatePullPointFault" + } + ], + "binding": "CreatePullPointBinding" + }, + { + "name": "Renew", + "port_type": "SubscriptionManager", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}RenewRequest", + "parts": [ + { + "name": "RenewRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}Renew", + "schema": { + "name": "Renew", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TerminationTime", + "type": "{http://docs.oasis-open.org/wsn/b-2}AbsoluteOrRelativeTimeType", + "type_name": "AbsoluteOrRelativeTimeType", + "definition": { + "kind": "simpleType", + "name": "AbsoluteOrRelativeTimeType", + "member_types": [ + "{http://www.w3.org/2001/XMLSchema}dateTime", + "{http://www.w3.org/2001/XMLSchema}duration" + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": true + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}RenewResponse", + "parts": [ + { + "name": "RenewResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}RenewResponse", + "schema": { + "name": "RenewResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TerminationTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}TerminationTime" + }, + { + "name": "CurrentTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}CurrentTime" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnacceptableTerminationTimeFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnacceptableTerminationTimeFault" + } + ], + "binding": "SubscriptionManagerBinding" + }, + { + "name": "Unsubscribe", + "port_type": "SubscriptionManager", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsubscribeRequest", + "parts": [ + { + "name": "UnsubscribeRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}Unsubscribe", + "schema": { + "name": "Unsubscribe", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsubscribeResponse", + "parts": [ + { + "name": "UnsubscribeResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}UnsubscribeResponse", + "schema": { + "name": "UnsubscribeResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnableToDestroySubscriptionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnableToDestroySubscriptionFault" + } + ], + "binding": "SubscriptionManagerBinding" + }, + { + "name": "Renew", + "port_type": "PausableSubscriptionManager", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}RenewRequest", + "parts": [ + { + "name": "RenewRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}Renew", + "schema": { + "name": "Renew", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TerminationTime", + "type": "{http://docs.oasis-open.org/wsn/b-2}AbsoluteOrRelativeTimeType", + "type_name": "AbsoluteOrRelativeTimeType", + "definition": { + "kind": "simpleType", + "name": "AbsoluteOrRelativeTimeType", + "member_types": [ + "{http://www.w3.org/2001/XMLSchema}dateTime", + "{http://www.w3.org/2001/XMLSchema}duration" + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": true + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}RenewResponse", + "parts": [ + { + "name": "RenewResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}RenewResponse", + "schema": { + "name": "RenewResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TerminationTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}TerminationTime" + }, + { + "name": "CurrentTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}CurrentTime" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnacceptableTerminationTimeFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnacceptableTerminationTimeFault" + } + ], + "binding": "PausableSubscriptionManagerBinding" + }, + { + "name": "Unsubscribe", + "port_type": "PausableSubscriptionManager", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsubscribeRequest", + "parts": [ + { + "name": "UnsubscribeRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}Unsubscribe", + "schema": { + "name": "Unsubscribe", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsubscribeResponse", + "parts": [ + { + "name": "UnsubscribeResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}UnsubscribeResponse", + "schema": { + "name": "UnsubscribeResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnableToDestroySubscriptionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnableToDestroySubscriptionFault" + } + ], + "binding": "PausableSubscriptionManagerBinding" + }, + { + "name": "PauseSubscription", + "port_type": "PausableSubscriptionManager", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}PauseSubscriptionRequest", + "parts": [ + { + "name": "PauseSubscriptionRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}PauseSubscription", + "schema": { + "name": "PauseSubscription", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}PauseSubscriptionResponse", + "parts": [ + { + "name": "PauseSubscriptionResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}PauseSubscriptionResponse", + "schema": { + "name": "PauseSubscriptionResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "PauseFailedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}PauseFailedFault" + } + ], + "binding": "PausableSubscriptionManagerBinding" + }, + { + "name": "ResumeSubscription", + "port_type": "PausableSubscriptionManager", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}ResumeSubscriptionRequest", + "parts": [ + { + "name": "ResumeSubscriptionRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}ResumeSubscription", + "schema": { + "name": "ResumeSubscription", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}ResumeSubscriptionResponse", + "parts": [ + { + "name": "ResumeSubscriptionResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}ResumeSubscriptionResponse", + "schema": { + "name": "ResumeSubscriptionResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "ResumeFailedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}ResumeFailedFault" + } + ], + "binding": "PausableSubscriptionManagerBinding" + } + ] +} diff --git a/docs/generated/wsdl/schema/common/rw-2.json b/docs/generated/wsdl/schema/common/rw-2.json new file mode 100644 index 00000000..7aeec504 --- /dev/null +++ b/docs/generated/wsdl/schema/common/rw-2.json @@ -0,0 +1,5 @@ +{ + "source": "schema/common/rw-2.wsdl", + "target_namespace": "http://docs.oasis-open.org/wsrf/rw-2", + "operations": [] +} diff --git a/docs/generated/wsdl/ver10/accessrules/wsdl/accessrules.json b/docs/generated/wsdl/ver10/accessrules/wsdl/accessrules.json new file mode 100644 index 00000000..5f02e2f5 --- /dev/null +++ b/docs/generated/wsdl/ver10/accessrules/wsdl/accessrules.json @@ -0,0 +1,1678 @@ +{ + "source": "ver10/accessrules/wsdl/accessrules.wsdl", + "target_namespace": "http://www.onvif.org/ver10/accessrules/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "AccessRulesPort", + "description": "This operation returns the capabilities of the access rules service.", + "input": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}ServiceCapabilities", + "type_name": "ServiceCapabilities", + "definition": { + "kind": "complexType", + "name": "ServiceCapabilities", + "description": "The service capabilities reflect optional functionality of a service. The information is static\n\t\t\t\t\t\tand does not change during device operation. The following capabilities are available:", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "MaxLimit", + "description": "The maximum number of entries returned by a single Get<Entity>List or Get<Entity>\n\t\t\t\t\t\t\trequest. The device shall never return more than this number of entities in a single\n\t\t\t\t\t\t\tresponse." + }, + { + "use": "required", + "name": "MaxAccessProfiles", + "description": "Indicates the maximum number of access profiles supported by the device." + }, + { + "use": "required", + "name": "MaxAccessPoliciesPerAccessProfile", + "description": "Indicates the maximum number of access policies per access profile supported by the device." + }, + { + "use": "required", + "name": "MultipleSchedulesPerAccessPointSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not several access policies can refer to the same access point in an\n\t\t\t\t\t\t\taccess profile." + }, + { + "use": "optional", + "name": "ClientSuppliedTokenSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false", + "description": "Indicates that the client is allowed to supply the token when creating access profiles. To\n\t\t\t\t\t\t\tenable the use of the command SetAccessProfile, the value must be set to true." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capability response message contains the requested access rules\n\t\t\t\t\t\t\t\t\tservice capabilities using a hierarchical XML capability structure." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AccessRulesBinding" + }, + { + "name": "GetAccessProfileInfo", + "port_type": "AccessRulesPort", + "description": "This operation requests a list of AccessProfileInfo items matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.", + "input": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfileInfoRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfileInfo", + "schema": { + "name": "GetAccessProfileInfo", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of AccessProfileInfo items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfileInfoResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfileInfoResponse", + "schema": { + "name": "GetAccessProfileInfoResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AccessProfileInfo", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfileInfo", + "type_name": "AccessProfileInfo", + "definition": { + "kind": "complexType", + "name": "AccessProfileInfo", + "description": "The AccessProfileInfo structure contains basic information about an access profile. The device\n\t\t\t\t\t\tshall provide the following fields for each access profile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of AccessProfileInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AccessRulesBinding" + }, + { + "name": "GetAccessProfileInfoList", + "port_type": "AccessRulesPort", + "description": "This operation requests a list of all of AccessProfileInfo items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. The number of items returned shall not be greater than the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfileInfoListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfileInfoList", + "schema": { + "name": "GetAccessProfileInfoList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is determined by the\n\t\t\t\t\t\t\t\t\tdevice." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfileInfoListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfileInfoListResponse", + "schema": { + "name": "GetAccessProfileInfoListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "AccessProfileInfo", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfileInfo", + "type_name": "AccessProfileInfo", + "definition": { + "kind": "complexType", + "name": "AccessProfileInfo", + "description": "The AccessProfileInfo structure contains basic information about an access profile. The device\n\t\t\t\t\t\tshall provide the following fields for each access profile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of AccessProfileInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AccessRulesBinding" + }, + { + "name": "GetAccessProfiles", + "port_type": "AccessRulesPort", + "description": "This operation returns the specified access profile item matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.", + "input": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfilesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfiles", + "schema": { + "name": "GetAccessProfiles", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of AccessProfile items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfilesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfilesResponse", + "schema": { + "name": "GetAccessProfilesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AccessProfile", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfile", + "type_name": "AccessProfile", + "definition": { + "kind": "complexType", + "name": "AccessProfile", + "description": "The access profile structure contains information about the collection of access policies. The\n\t\t\t\t\t\tdevice shall include all properties of the AccessProfileInfo structure and also a list of access\n\t\t\t\t\t\tpolicies.", + "base": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfileInfo", + "base_definition": { + "kind": "complexType", + "name": "AccessProfileInfo", + "description": "The AccessProfileInfo structure contains basic information about an access profile. The device\n\t\t\t\t\t\tshall provide the following fields for each access profile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "AccessPolicy", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessPolicy", + "type_name": "AccessPolicy", + "definition": { + "kind": "complexType", + "name": "AccessPolicy", + "description": "The access policy is an association of an access point and a schedule. It defines when an access\n\t\t\t\t\t\tpoint can be accessed using an access profile which contains this access policy. If an access\n\t\t\t\t\t\tprofile contains several access policies specifying different schedules for the same access\n\t\t\t\t\t\tpoint will result in a union of the schedules.", + "fields": [ + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the schedule used by the access policy." + }, + { + "name": "Entity", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the entity used by the rule engine, the entity type may be specified by the\n\t\t\t\t\t\t\t\toptional EntityType field explained below but is typically an access point." + }, + { + "name": "EntityType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional entity type; if missing, an access point type as defined by the ONVIF Access\n\t\t\t\t\t\t\t\tControl Service Specification should be assumed. This can also be represented by the\n\t\t\t\t\t\t\t\tQName value\t\"tac:AccessPoint\" where tac is the namespace of ONVIF Access Control\n\t\t\t\t\t\t\t\tService Specification. This field is provided for future extensions; it will allow an\n\t\t\t\t\t\t\t\taccess policy being\textended to cover entity types other than access points as well." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessPolicyExtension", + "type_name": "AccessPolicyExtension", + "definition": { + "kind": "complexType", + "name": "AccessPolicyExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of access policy structures, where each access policy\n\t\t\t\t\t\t\t\t\t\tdefines during which schedule an access point can be accessed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfileExtension", + "type_name": "AccessProfileExtension", + "definition": { + "kind": "complexType", + "name": "AccessProfileExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of Access Profile items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AccessRulesBinding" + }, + { + "name": "GetAccessProfileList", + "port_type": "AccessRulesPort", + "description": "This operation requests a list of all of access profile items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. The number of items returned shall not be greater than the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfileListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfileList", + "schema": { + "name": "GetAccessProfileList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is determined by the\n\t\t\t\t\t\t\t\t\tdevice." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfileListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}GetAccessProfileListResponse", + "schema": { + "name": "GetAccessProfileListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "AccessProfile", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfile", + "type_name": "AccessProfile", + "definition": { + "kind": "complexType", + "name": "AccessProfile", + "description": "The access profile structure contains information about the collection of access policies. The\n\t\t\t\t\t\tdevice shall include all properties of the AccessProfileInfo structure and also a list of access\n\t\t\t\t\t\tpolicies.", + "base": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfileInfo", + "base_definition": { + "kind": "complexType", + "name": "AccessProfileInfo", + "description": "The AccessProfileInfo structure contains basic information about an access profile. The device\n\t\t\t\t\t\tshall provide the following fields for each access profile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "AccessPolicy", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessPolicy", + "type_name": "AccessPolicy", + "definition": { + "kind": "complexType", + "name": "AccessPolicy", + "description": "The access policy is an association of an access point and a schedule. It defines when an access\n\t\t\t\t\t\tpoint can be accessed using an access profile which contains this access policy. If an access\n\t\t\t\t\t\tprofile contains several access policies specifying different schedules for the same access\n\t\t\t\t\t\tpoint will result in a union of the schedules.", + "fields": [ + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the schedule used by the access policy." + }, + { + "name": "Entity", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the entity used by the rule engine, the entity type may be specified by the\n\t\t\t\t\t\t\t\toptional EntityType field explained below but is typically an access point." + }, + { + "name": "EntityType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional entity type; if missing, an access point type as defined by the ONVIF Access\n\t\t\t\t\t\t\t\tControl Service Specification should be assumed. This can also be represented by the\n\t\t\t\t\t\t\t\tQName value\t\"tac:AccessPoint\" where tac is the namespace of ONVIF Access Control\n\t\t\t\t\t\t\t\tService Specification. This field is provided for future extensions; it will allow an\n\t\t\t\t\t\t\t\taccess policy being\textended to cover entity types other than access points as well." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessPolicyExtension", + "type_name": "AccessPolicyExtension", + "definition": { + "kind": "complexType", + "name": "AccessPolicyExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of access policy structures, where each access policy\n\t\t\t\t\t\t\t\t\t\tdefines during which schedule an access point can be accessed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfileExtension", + "type_name": "AccessProfileExtension", + "definition": { + "kind": "complexType", + "name": "AccessProfileExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of Access Profile items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AccessRulesBinding" + }, + { + "name": "CreateAccessProfile", + "port_type": "AccessRulesPort", + "description": "This operation creates the specified access profile in the device. The token field of the access profile shall be empty, the service shall allocate a token for the access profile. The allocated token shall be returned in the response. If the client sends any value in the token field, the device shall return InvalidArgVal as generic fault code. In an access profile, if several access policies specifying different schedules for the same access point will result in a union of the schedules.", + "input": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}CreateAccessProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}CreateAccessProfile", + "schema": { + "name": "CreateAccessProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AccessProfile", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfile", + "type_name": "AccessProfile", + "definition": { + "kind": "complexType", + "name": "AccessProfile", + "description": "The access profile structure contains information about the collection of access policies. The\n\t\t\t\t\t\tdevice shall include all properties of the AccessProfileInfo structure and also a list of access\n\t\t\t\t\t\tpolicies.", + "base": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfileInfo", + "base_definition": { + "kind": "complexType", + "name": "AccessProfileInfo", + "description": "The AccessProfileInfo structure contains basic information about an access profile. The device\n\t\t\t\t\t\tshall provide the following fields for each access profile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "AccessPolicy", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessPolicy", + "type_name": "AccessPolicy", + "definition": { + "kind": "complexType", + "name": "AccessPolicy", + "description": "The access policy is an association of an access point and a schedule. It defines when an access\n\t\t\t\t\t\tpoint can be accessed using an access profile which contains this access policy. If an access\n\t\t\t\t\t\tprofile contains several access policies specifying different schedules for the same access\n\t\t\t\t\t\tpoint will result in a union of the schedules.", + "fields": [ + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the schedule used by the access policy." + }, + { + "name": "Entity", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the entity used by the rule engine, the entity type may be specified by the\n\t\t\t\t\t\t\t\toptional EntityType field explained below but is typically an access point." + }, + { + "name": "EntityType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional entity type; if missing, an access point type as defined by the ONVIF Access\n\t\t\t\t\t\t\t\tControl Service Specification should be assumed. This can also be represented by the\n\t\t\t\t\t\t\t\tQName value\t\"tac:AccessPoint\" where tac is the namespace of ONVIF Access Control\n\t\t\t\t\t\t\t\tService Specification. This field is provided for future extensions; it will allow an\n\t\t\t\t\t\t\t\taccess policy being\textended to cover entity types other than access points as well." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessPolicyExtension", + "type_name": "AccessPolicyExtension", + "definition": { + "kind": "complexType", + "name": "AccessPolicyExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of access policy structures, where each access policy\n\t\t\t\t\t\t\t\t\t\tdefines during which schedule an access point can be accessed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfileExtension", + "type_name": "AccessProfileExtension", + "definition": { + "kind": "complexType", + "name": "AccessProfileExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The AccessProfile to create." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}CreateAccessProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}CreateAccessProfileResponse", + "schema": { + "name": "CreateAccessProfileResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The Token of created AccessProfile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AccessRulesBinding" + }, + { + "name": "ModifyAccessProfile", + "port_type": "AccessRulesPort", + "description": "This operation will modify the access profile for the specified access profile token. The token of the access profile to modify is specified in the token field of the AccessProile structure and shall not be empty. All other fields in the structure shall overwrite the fields in the specified access profile. If several access policies specifying different schedules for the same access point will result in a union of the schedules. If the device could not store the access profile information then a fault will be generated.", + "input": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}ModifyAccessProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}ModifyAccessProfile", + "schema": { + "name": "ModifyAccessProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AccessProfile", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfile", + "type_name": "AccessProfile", + "definition": { + "kind": "complexType", + "name": "AccessProfile", + "description": "The access profile structure contains information about the collection of access policies. The\n\t\t\t\t\t\tdevice shall include all properties of the AccessProfileInfo structure and also a list of access\n\t\t\t\t\t\tpolicies.", + "base": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfileInfo", + "base_definition": { + "kind": "complexType", + "name": "AccessProfileInfo", + "description": "The AccessProfileInfo structure contains basic information about an access profile. The device\n\t\t\t\t\t\tshall provide the following fields for each access profile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "AccessPolicy", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessPolicy", + "type_name": "AccessPolicy", + "definition": { + "kind": "complexType", + "name": "AccessPolicy", + "description": "The access policy is an association of an access point and a schedule. It defines when an access\n\t\t\t\t\t\tpoint can be accessed using an access profile which contains this access policy. If an access\n\t\t\t\t\t\tprofile contains several access policies specifying different schedules for the same access\n\t\t\t\t\t\tpoint will result in a union of the schedules.", + "fields": [ + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the schedule used by the access policy." + }, + { + "name": "Entity", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the entity used by the rule engine, the entity type may be specified by the\n\t\t\t\t\t\t\t\toptional EntityType field explained below but is typically an access point." + }, + { + "name": "EntityType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional entity type; if missing, an access point type as defined by the ONVIF Access\n\t\t\t\t\t\t\t\tControl Service Specification should be assumed. This can also be represented by the\n\t\t\t\t\t\t\t\tQName value\t\"tac:AccessPoint\" where tac is the namespace of ONVIF Access Control\n\t\t\t\t\t\t\t\tService Specification. This field is provided for future extensions; it will allow an\n\t\t\t\t\t\t\t\taccess policy being\textended to cover entity types other than access points as well." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessPolicyExtension", + "type_name": "AccessPolicyExtension", + "definition": { + "kind": "complexType", + "name": "AccessPolicyExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of access policy structures, where each access policy\n\t\t\t\t\t\t\t\t\t\tdefines during which schedule an access point can be accessed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfileExtension", + "type_name": "AccessProfileExtension", + "definition": { + "kind": "complexType", + "name": "AccessProfileExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The details of Access Profile" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}ModifyAccessProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}ModifyAccessProfileResponse", + "schema": { + "name": "ModifyAccessProfileResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AccessRulesBinding" + }, + { + "name": "SetAccessProfile", + "port_type": "AccessRulesPort", + "description": "This operation will synchronize an access profile in a client with the device. If an access profile with the specified token does not exist in the device, the access profile is created. If an access profile with the specified token exists, then the access profile is modified. A call to this method takes an access profile structure as input parameter. The token field of the access profile must not be empty. A device that signals support for the ClientSuppliedTokenSupported capability shall implement this command.", + "input": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}SetAccessProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}SetAccessProfile", + "schema": { + "name": "SetAccessProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AccessProfile", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfile", + "type_name": "AccessProfile", + "definition": { + "kind": "complexType", + "name": "AccessProfile", + "description": "The access profile structure contains information about the collection of access policies. The\n\t\t\t\t\t\tdevice shall include all properties of the AccessProfileInfo structure and also a list of access\n\t\t\t\t\t\tpolicies.", + "base": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfileInfo", + "base_definition": { + "kind": "complexType", + "name": "AccessProfileInfo", + "description": "The AccessProfileInfo structure contains basic information about an access profile. The device\n\t\t\t\t\t\tshall provide the following fields for each access profile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "AccessPolicy", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessPolicy", + "type_name": "AccessPolicy", + "definition": { + "kind": "complexType", + "name": "AccessPolicy", + "description": "The access policy is an association of an access point and a schedule. It defines when an access\n\t\t\t\t\t\tpoint can be accessed using an access profile which contains this access policy. If an access\n\t\t\t\t\t\tprofile contains several access policies specifying different schedules for the same access\n\t\t\t\t\t\tpoint will result in a union of the schedules.", + "fields": [ + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the schedule used by the access policy." + }, + { + "name": "Entity", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the entity used by the rule engine, the entity type may be specified by the\n\t\t\t\t\t\t\t\toptional EntityType field explained below but is typically an access point." + }, + { + "name": "EntityType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional entity type; if missing, an access point type as defined by the ONVIF Access\n\t\t\t\t\t\t\t\tControl Service Specification should be assumed. This can also be represented by the\n\t\t\t\t\t\t\t\tQName value\t\"tac:AccessPoint\" where tac is the namespace of ONVIF Access Control\n\t\t\t\t\t\t\t\tService Specification. This field is provided for future extensions; it will allow an\n\t\t\t\t\t\t\t\taccess policy being\textended to cover entity types other than access points as well." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessPolicyExtension", + "type_name": "AccessPolicyExtension", + "definition": { + "kind": "complexType", + "name": "AccessPolicyExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of access policy structures, where each access policy\n\t\t\t\t\t\t\t\t\t\tdefines during which schedule an access point can be accessed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accessrules/wsdl}AccessProfileExtension", + "type_name": "AccessProfileExtension", + "definition": { + "kind": "complexType", + "name": "AccessProfileExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The AccessProfile item to create or modify" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}SetAccessProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}SetAccessProfileResponse", + "schema": { + "name": "SetAccessProfileResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AccessRulesBinding" + }, + { + "name": "DeleteAccessProfile", + "port_type": "AccessRulesPort", + "description": "This operation will delete the specified access profile. If the access profile is deleted, all access policies associated to the access profile will also be deleted. If it is associated with one or more entities some devices may not be able to delete the access profile, and consequently a ReferenceInUse fault shall be generated.", + "input": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}DeleteAccessProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}DeleteAccessProfile", + "schema": { + "name": "DeleteAccessProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the access profile to delete." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accessrules/wsdl}DeleteAccessProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accessrules/wsdl}DeleteAccessProfileResponse", + "schema": { + "name": "DeleteAccessProfileResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AccessRulesBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/actionengine.json b/docs/generated/wsdl/ver10/actionengine.json new file mode 100644 index 00000000..7877581e --- /dev/null +++ b/docs/generated/wsdl/ver10/actionengine.json @@ -0,0 +1,2125 @@ +{ + "source": "ver10/actionengine.wsdl", + "target_namespace": "http://www.onvif.org/ver10/actionengine/wsdl", + "operations": [ + { + "name": "GetSupportedActions", + "port_type": "ActionEnginePort", + "description": "The service provider returns the supported action types. The response returns a list of Action Descriptions according to the Action Description Language. The response also contains a list of URLs that provide the location of the schema files. These schema files describe the types and elements used in the Action Descriptions. If action descriptions reference types or elements of the ONVIF schema file, the ONVIF schema file shall be explicitly listed.", + "input": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}GetSupportedActionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}GetSupportedActions", + "schema": { + "name": "GetSupportedActions", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}GetSupportedActionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}GetSupportedActionsResponse", + "schema": { + "name": "GetSupportedActionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SupportedActions", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}SupportedActions", + "type_name": "SupportedActions", + "definition": { + "kind": "complexType", + "name": "SupportedActions", + "description": "SupportedActions data structure lists the available action types that service provider supports. For each action type, data structure contains the action configuration parameters.", + "fields": [ + { + "name": "ActionContentSchemaLocation", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Lists the location of all schemas that are referenced in the supported actions. If the action descriptions reference data types in the ONVIF schema file,the ONVIF schema file MUST be explicitly listed." + }, + { + "name": "ActionDescription", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionConfigDescription", + "type_name": "ActionConfigDescription", + "definition": { + "kind": "complexType", + "name": "ActionConfigDescription", + "description": "Describes the configuration parameters of an action.", + "fields": [ + { + "name": "ParameterDescription", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescription", + "type_name": "ItemListDescription", + "definition": { + "kind": "complexType", + "name": "ItemListDescription", + "description": "Describes a list of items. Each item in the list shall have a unique name.\n\t\t\tThe list is designed as linear structure without optional or unbounded elements.\n\t\t\tUse ElementItems only when complex structures are inevitable.", + "fields": [ + { + "name": "SimpleItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...)." + }, + { + "name": "ElementItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a complex type. The Type must reference a defined type." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescriptionExtension", + "type_name": "ItemListDescriptionExtension", + "definition": { + "kind": "complexType", + "name": "ItemListDescriptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Action configuration parameter descriptions" + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "Action type name" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of actions supported by Action Engine Service provider." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}SupportedActionsExtension", + "type_name": "SupportedActionsExtension", + "definition": { + "kind": "complexType", + "name": "SupportedActionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Array of supported Action types" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ActionEngineBinding" + }, + { + "name": "GetActions", + "port_type": "ActionEnginePort", + "description": "The service provider returns currently installed Actions.", + "input": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}GetActionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}GetActions", + "schema": { + "name": "GetActions", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}GetActionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}GetActionsResponse", + "schema": { + "name": "GetActionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Action", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}Action", + "type_name": "Action", + "definition": { + "kind": "complexType", + "name": "Action", + "description": "Action data type contains the configuration settings of one action instance and service provider assigned unique identifier for this action configuration.", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionConfiguration", + "type_name": "ActionConfiguration", + "definition": { + "kind": "complexType", + "name": "ActionConfiguration", + "description": "Action Configuration data type contains the configuration settings of action configuration parameters, service requester given action Name, and service provider supported action type value", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Action configuration parameter settings." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "User given name." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "Denotes the action type." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Action configuration contains action type, user given action name, and configuratin parameter settings." + } + ], + "attributes": [ + { + "use": "required", + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique Action identifier that service provider assigned to the action configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Array of current Action configurations" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ActionEngineBinding" + }, + { + "name": "CreateActions", + "port_type": "ActionEnginePort", + "description": "The create action operation adds actions to configuration. The create action operation is atomic. If a service provider can not create all of requested actions, the service provider responds with a fault message.", + "input": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}CreateActionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}CreateActions", + "schema": { + "name": "CreateActions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Action", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionConfiguration", + "type_name": "ActionConfiguration", + "definition": { + "kind": "complexType", + "name": "ActionConfiguration", + "description": "Action Configuration data type contains the configuration settings of action configuration parameters, service requester given action Name, and service provider supported action type value", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Action configuration parameter settings." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "User given name." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "Denotes the action type." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Array of Actions to be configured on service provider" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}CreateActionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}CreateActionsResponse", + "schema": { + "name": "CreateActionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Action", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}Action", + "type_name": "Action", + "definition": { + "kind": "complexType", + "name": "Action", + "description": "Action data type contains the configuration settings of one action instance and service provider assigned unique identifier for this action configuration.", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionConfiguration", + "type_name": "ActionConfiguration", + "definition": { + "kind": "complexType", + "name": "ActionConfiguration", + "description": "Action Configuration data type contains the configuration settings of action configuration parameters, service requester given action Name, and service provider supported action type value", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Action configuration parameter settings." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "User given name." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "Denotes the action type." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Action configuration contains action type, user given action name, and configuratin parameter settings." + } + ], + "attributes": [ + { + "use": "required", + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique Action identifier that service provider assigned to the action configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Array of configured Actions with service provider assigned unique identifiers" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ActionEngineBinding" + }, + { + "name": "DeleteActions", + "port_type": "ActionEnginePort", + "description": "The delete operation deletes actions. The delete action operation is atomic. If a service provider can not delete all of requested actions, the service provider responds with a fault message.", + "input": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}DeleteActionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}DeleteActions", + "schema": { + "name": "DeleteActions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Array of tokens referencing existing Action configurations to be removed" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}DeleteActionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}DeleteActionsResponse", + "schema": { + "name": "DeleteActionsResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ActionEngineBinding" + }, + { + "name": "ModifyActions", + "port_type": "ActionEnginePort", + "description": "The modify action operation modifies action configurations. The modify action operation is atomic. If a service provider can not modify all of requested action configurations, the service provider responds with a fault message. All action parameters, except the action type, can be modified. The service provider shall return InvalidAction error if the request attempts to change the action type with modify action request.", + "input": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}ModifyActionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}ModifyActions", + "schema": { + "name": "ModifyActions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Action", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}Action", + "type_name": "Action", + "definition": { + "kind": "complexType", + "name": "Action", + "description": "Action data type contains the configuration settings of one action instance and service provider assigned unique identifier for this action configuration.", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionConfiguration", + "type_name": "ActionConfiguration", + "definition": { + "kind": "complexType", + "name": "ActionConfiguration", + "description": "Action Configuration data type contains the configuration settings of action configuration parameters, service requester given action Name, and service provider supported action type value", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Action configuration parameter settings." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "User given name." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "Denotes the action type." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Action configuration contains action type, user given action name, and configuratin parameter settings." + } + ], + "attributes": [ + { + "use": "required", + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique Action identifier that service provider assigned to the action configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Array of Action configurations to update the existing action configurations" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}ModifyActionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}ModifyActionsResponse", + "schema": { + "name": "ModifyActionsResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ActionEngineBinding" + }, + { + "name": "GetServiceCapabilities", + "port_type": "ActionEnginePort", + "description": "The get capabilities operation returns the Action Engine capabilities", + "input": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionEngineCapabilities", + "type_name": "ActionEngineCapabilities", + "definition": { + "kind": "complexType", + "name": "ActionEngineCapabilities", + "description": "Action Engine Capabilities data structure contains the maximum number of supported actions and number of actions in use for generic as well as specific action types", + "fields": [ + { + "name": "ActionCapabilities", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionTypeLimits", + "type_name": "ActionTypeLimits", + "definition": { + "kind": "complexType", + "name": "ActionTypeLimits", + "description": "ActionTypeLimits data structure contains maximum and current usage information for a specific action type in the service provider", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "Action Type" + }, + { + "use": "required", + "name": "Maximum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "description": "For the specific action type, the maximum number of actions that could be concurrently supported by the service provider" + }, + { + "use": "optional", + "name": "InUse", + "type": "{http://www.w3.org/2001/XMLSchema}nonNegativeInteger", + "default": "0", + "description": "For the specific action type, the number of actions in use by the service provider" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Limits for each action type" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionEngineCapabilitiesExtension", + "type_name": "ActionEngineCapabilitiesExtension", + "definition": { + "kind": "complexType", + "name": "ActionEngineCapabilitiesExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "MaximumTriggers", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "description": "The maximum number of trigger configurations that the service provider can concurrently support" + }, + { + "use": "optional", + "name": "MaximumActions", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "description": "The maximum number of actions that the service provider can concurrently support" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ActionEngineBinding" + }, + { + "name": "GetActionTriggers", + "port_type": "ActionEnginePort", + "description": "The service provider returns existing action triggers", + "input": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}GetActionTriggersRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}GetActionTriggers", + "schema": { + "name": "GetActionTriggers", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}GetActionTriggersResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}GetActionTriggersResponse", + "schema": { + "name": "GetActionTriggersResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ActionTrigger", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionTrigger", + "type_name": "ActionTrigger", + "definition": { + "kind": "complexType", + "name": "ActionTrigger", + "description": "Action Trigger data type contains the service provider assigned unique identifier for the configuration and action trigger configuration data.", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionTriggerConfiguration", + "type_name": "ActionTriggerConfiguration", + "definition": { + "kind": "complexType", + "name": "ActionTriggerConfiguration", + "description": "Action Trigger configuration data type contains mandatory Topic Expression (Section Topic Filter in [Core Specification]), optional Message content expression (Section Message Content Filter in [Core Specification]), and set of actions to be triggered.", + "fields": [ + { + "name": "TopicExpression", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Topic expression, for example, to trigger only for relays. Trigger based on event topic." + }, + { + "name": "ContentExpression", + "type": "{http://docs.oasis-open.org/wsn/b-2}QueryExpressionType", + "type_name": "QueryExpressionType", + "definition": { + "kind": "complexType", + "name": "QueryExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Content expression, for example, to trigger only when the relay value is on. Trigger based on content data in event." + }, + { + "name": "ActionToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Reference to actions to be triggered when the conditions are satisfied." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionTriggerConfigurationExtension", + "type_name": "ActionTriggerConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "ActionTriggerConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Action Trigger Configuration" + } + ], + "attributes": [ + { + "use": "required", + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique Action Trigger identifier that service provider assigned to the action trigger configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Array of current Action Trigger configurations" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ActionEngineBinding" + }, + { + "name": "CreateActionTriggers", + "port_type": "ActionEnginePort", + "description": "Creates action triggers. The create action triggers operation is atomic. If a service provider can not create all of requested action triggers, the service provider responds with a fault message.", + "input": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}CreateActionTriggersRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}CreateActionTriggers", + "schema": { + "name": "CreateActionTriggers", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ActionTrigger", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionTriggerConfiguration", + "type_name": "ActionTriggerConfiguration", + "definition": { + "kind": "complexType", + "name": "ActionTriggerConfiguration", + "description": "Action Trigger configuration data type contains mandatory Topic Expression (Section Topic Filter in [Core Specification]), optional Message content expression (Section Message Content Filter in [Core Specification]), and set of actions to be triggered.", + "fields": [ + { + "name": "TopicExpression", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Topic expression, for example, to trigger only for relays. Trigger based on event topic." + }, + { + "name": "ContentExpression", + "type": "{http://docs.oasis-open.org/wsn/b-2}QueryExpressionType", + "type_name": "QueryExpressionType", + "definition": { + "kind": "complexType", + "name": "QueryExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Content expression, for example, to trigger only when the relay value is on. Trigger based on content data in event." + }, + { + "name": "ActionToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Reference to actions to be triggered when the conditions are satisfied." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionTriggerConfigurationExtension", + "type_name": "ActionTriggerConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "ActionTriggerConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Action Triggers to be configured" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}CreateActionTriggersResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}CreateActionTriggersResponse", + "schema": { + "name": "CreateActionTriggersResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ActionTrigger", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionTrigger", + "type_name": "ActionTrigger", + "definition": { + "kind": "complexType", + "name": "ActionTrigger", + "description": "Action Trigger data type contains the service provider assigned unique identifier for the configuration and action trigger configuration data.", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionTriggerConfiguration", + "type_name": "ActionTriggerConfiguration", + "definition": { + "kind": "complexType", + "name": "ActionTriggerConfiguration", + "description": "Action Trigger configuration data type contains mandatory Topic Expression (Section Topic Filter in [Core Specification]), optional Message content expression (Section Message Content Filter in [Core Specification]), and set of actions to be triggered.", + "fields": [ + { + "name": "TopicExpression", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Topic expression, for example, to trigger only for relays. Trigger based on event topic." + }, + { + "name": "ContentExpression", + "type": "{http://docs.oasis-open.org/wsn/b-2}QueryExpressionType", + "type_name": "QueryExpressionType", + "definition": { + "kind": "complexType", + "name": "QueryExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Content expression, for example, to trigger only when the relay value is on. Trigger based on content data in event." + }, + { + "name": "ActionToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Reference to actions to be triggered when the conditions are satisfied." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionTriggerConfigurationExtension", + "type_name": "ActionTriggerConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "ActionTriggerConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Action Trigger Configuration" + } + ], + "attributes": [ + { + "use": "required", + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique Action Trigger identifier that service provider assigned to the action trigger configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Returns configured Action Triggers with service provider assigned unique identifers" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ActionEngineBinding" + }, + { + "name": "DeleteActionTriggers", + "port_type": "ActionEnginePort", + "description": "Deletes action triggers. The delete action triggers operation is atomic. If a service provider can not delete all of requested action triggers, the service provider responds with a fault message.", + "input": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}DeleteActionTriggersRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}DeleteActionTriggers", + "schema": { + "name": "DeleteActionTriggers", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Array of tokens referencing existing Action Trigger configurations to be removed" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}DeleteActionTriggersResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}DeleteActionTriggersResponse", + "schema": { + "name": "DeleteActionTriggersResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ActionEngineBinding" + }, + { + "name": "ModifyActionTriggers", + "port_type": "ActionEnginePort", + "description": "Modifies existing action triggers. The modify action triggers operation is atomic. If a service provider can not modify all of requested action trigger configurations, the service provider responds with a fault message.", + "input": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}ModifyActionTriggersRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}ModifyActionTriggers", + "schema": { + "name": "ModifyActionTriggers", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ActionTrigger", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionTrigger", + "type_name": "ActionTrigger", + "definition": { + "kind": "complexType", + "name": "ActionTrigger", + "description": "Action Trigger data type contains the service provider assigned unique identifier for the configuration and action trigger configuration data.", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionTriggerConfiguration", + "type_name": "ActionTriggerConfiguration", + "definition": { + "kind": "complexType", + "name": "ActionTriggerConfiguration", + "description": "Action Trigger configuration data type contains mandatory Topic Expression (Section Topic Filter in [Core Specification]), optional Message content expression (Section Message Content Filter in [Core Specification]), and set of actions to be triggered.", + "fields": [ + { + "name": "TopicExpression", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Topic expression, for example, to trigger only for relays. Trigger based on event topic." + }, + { + "name": "ContentExpression", + "type": "{http://docs.oasis-open.org/wsn/b-2}QueryExpressionType", + "type_name": "QueryExpressionType", + "definition": { + "kind": "complexType", + "name": "QueryExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Content expression, for example, to trigger only when the relay value is on. Trigger based on content data in event." + }, + { + "name": "ActionToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Reference to actions to be triggered when the conditions are satisfied." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/actionengine/wsdl}ActionTriggerConfigurationExtension", + "type_name": "ActionTriggerConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "ActionTriggerConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Action Trigger Configuration" + } + ], + "attributes": [ + { + "use": "required", + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique Action Trigger identifier that service provider assigned to the action trigger configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Array of Action Trigger configurations to be updated." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/actionengine/wsdl}ModifyActionTriggersResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/actionengine/wsdl}ModifyActionTriggersResponse", + "schema": { + "name": "ModifyActionTriggersResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ActionEngineBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/advancedsecurity/wsdl/advancedsecurity.json b/docs/generated/wsdl/ver10/advancedsecurity/wsdl/advancedsecurity.json new file mode 100644 index 00000000..c9690019 --- /dev/null +++ b/docs/generated/wsdl/ver10/advancedsecurity/wsdl/advancedsecurity.json @@ -0,0 +1,8187 @@ +{ + "source": "ver10/advancedsecurity/wsdl/advancedsecurity.wsdl", + "target_namespace": "http://www.onvif.org/ver10/advancedsecurity/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "AdvancedSecurityService", + "description": "Returns the capabilities of the security configuration service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "description": "The capabilities of a Security Configuration Service implementation on a device.", + "fields": [ + { + "name": "KeystoreCapabilities", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeystoreCapabilities", + "type_name": "KeystoreCapabilities", + "definition": { + "kind": "complexType", + "name": "KeystoreCapabilities", + "description": "The capabilities of a keystore implementation on a device.", + "fields": [ + { + "name": "SignatureAlgorithms", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AlgorithmIdentifier", + "type_name": "AlgorithmIdentifier", + "definition": { + "kind": "complexType", + "name": "AlgorithmIdentifier", + "description": "An identifier of an algorithm.", + "fields": [ + { + "name": "algorithm", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DotDecimalOID", + "type_name": "DotDecimalOID", + "definition": { + "kind": "simpleType", + "name": "DotDecimalOID", + "description": "An object identifier (OID) in dot-decimal form as specified in RFC4512.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "[0-9]+(.[0-9]+)*" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The OID of the algorithm in dot-decimal form." + }, + { + "name": "parameters", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameters of the algorithm (depending on the algorithm)." + }, + { + "name": "anyParameters", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The signature algorithms supported by the keystore implementation." + }, + { + "name": "anyElement", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "MaximumNumberOfKeys", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "description": "Indicates the maximum number of private keys that the device can store simultaneously." + }, + { + "use": "optional", + "name": "MaximumNumberOfCertificates", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "description": "Indicates the maximum number of certificates that the device can store simultaneously." + }, + { + "use": "optional", + "name": "MaximumNumberOfCertificationPaths", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "description": "Indicates the maximum number of certification paths that the device can store simultaneously." + }, + { + "use": "optional", + "name": "SetCertPath", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for modifying an existing certification path or certification path validation policy." + }, + { + "use": "optional", + "name": "RSAKeyPairGeneration", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Deprecated - Indication that the device supports on-board ECC key pair generation." + }, + { + "use": "optional", + "name": "ECCKeyPairGeneration", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Deprecated - Indication that the device supports on-board ECC key pair generation." + }, + { + "use": "optional", + "name": "KeyPairGeneration", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported key algorithm like 'RSA' and 'ECC'. For a full list of definitions see tas:KeyPairAlgorithm." + }, + { + "use": "optional", + "name": "RSAKeyLengths", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}RSAKeyLengths", + "definition": { + "kind": "simpleType", + "name": "RSAKeyLengths", + "description": "A list of RSA key lenghts in bits.", + "item_type": "{http://www.w3.org/2001/XMLSchema}nonNegativeInteger" + }, + "description": "Indicates which RSA key lengths are supported by the device." + }, + { + "use": "optional", + "name": "EllipticCurves", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}EllipticCurves", + "definition": { + "kind": "simpleType", + "name": "EllipticCurves", + "description": "A list of elliptic curves.", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Indicates which elliptic curves are supported by the device. Supported curve names can be found in the IANA TLS Supported Groups section, under the Description field." + }, + { + "use": "optional", + "name": "PKCS10ExternalCertificationWithRSA", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Deprecated - Indicates support for creating PKCS#10 requests for RSA keys and uploading the certificate obtained from a CA.." + }, + { + "use": "optional", + "name": "PKCS10", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for creating PKCS#10 requests for keypairs and uploading the certificate obtained from a CA." + }, + { + "use": "optional", + "name": "SelfSignedCertificateCreationWithRSA", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Deprecated - Indicates support for creating self-signed certificates for RSA keys." + }, + { + "use": "optional", + "name": "SelfSignedCertificateCreation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for creating self-signed certificates." + }, + { + "use": "optional", + "name": "X509Versions", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}X509Versions", + "definition": { + "kind": "simpleType", + "name": "X509Versions", + "description": "A list of X.509 versions.", + "item_type": "{http://www.w3.org/2001/XMLSchema}int" + }, + "description": "Indicates which X.509 versions are supported by the device." + }, + { + "use": "optional", + "name": "MaximumNumberOfPassphrases", + "type": "{http://www.w3.org/2001/XMLSchema}nonNegativeInteger", + "description": "Indicates the maximum number of passphrases that the device is able to store simultaneously." + }, + { + "use": "optional", + "name": "PKCS8RSAKeyPairUpload", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Deprecated - Indicates support for uploading an RSA key pair in a PKCS#8 data structure." + }, + { + "use": "optional", + "name": "PKCS8", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Deprecated - Indicates support for uploading a key pair in a PKCS#8 data structure." + }, + { + "use": "optional", + "name": "PKCS12CertificateWithRSAPrivateKeyUpload", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Deprecated - Indicates support for uploading a certificate along with an RSA private key in a PKCS#12 data structure." + }, + { + "use": "optional", + "name": "PKCS12", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for uploading a certificate along with a private key in a PKCS#12 data structure." + }, + { + "use": "optional", + "name": "PasswordBasedEncryptionAlgorithms", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}PasswordBasedEncryptionAlgorithms", + "definition": { + "kind": "simpleType", + "name": "PasswordBasedEncryptionAlgorithms", + "description": "A list of password based encryption algorithms.", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Indicates which password-based encryption algorithms are supported by the device." + }, + { + "use": "optional", + "name": "PasswordBasedMACAlgorithms", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}PasswordBasedMACAlgorithms", + "definition": { + "kind": "simpleType", + "name": "PasswordBasedMACAlgorithms", + "description": "A list of password based MAC algorithms.", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Deprecated - Indicates which password-based MAC algorithms are supported by the device." + }, + { + "use": "optional", + "name": "MaximumNumberOfCRLs", + "type": "{http://www.w3.org/2001/XMLSchema}nonNegativeInteger", + "description": "Indicates the maximum number of CRLs that the device is able to store simultaneously." + }, + { + "use": "optional", + "name": "MaximumNumberOfCertificationPathValidationPolicies", + "type": "{http://www.w3.org/2001/XMLSchema}nonNegativeInteger", + "description": "Indicates the maximum number of certification path validation policies that the device is able to store simultaneously." + }, + { + "use": "optional", + "name": "EnforceTLSWebClientAuthExtKeyUsage", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether a device supports checking for the TLS WWW client auth extended key usage extension while validating certification paths." + }, + { + "use": "optional", + "name": "NoPrivateKeySharing", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates the device requires that each certificate with private key has its own unique key." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities of the keystore implementation." + }, + { + "name": "TLSServerCapabilities", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}TLSServerCapabilities", + "type_name": "TLSServerCapabilities", + "definition": { + "kind": "complexType", + "name": "TLSServerCapabilities", + "description": "The capabilities of a TLS server implementation on a device.", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "TLSServerSupported", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}TLSVersions", + "definition": { + "kind": "simpleType", + "name": "TLSVersions", + "description": "A list of TLS versions.", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Indicates which TLS versions are supported by the device." + }, + { + "use": "optional", + "name": "EnabledVersionsSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether the device supports enabling and disabling specific TLS versions." + }, + { + "use": "optional", + "name": "MaximumNumberOfTLSCertificationPaths", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "description": "Indicates the maximum number of certification paths that may be assigned to the TLS server simultaneously." + }, + { + "use": "optional", + "name": "SetupDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "description": "Indicates the maximum time taken for updated TLS server settings to take effect." + }, + { + "use": "optional", + "name": "TLSClientAuthSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether the device supports TLS client authentication." + }, + { + "use": "optional", + "name": "CnMapsToUserSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether the device supports TLS client authorization using common name to local user mapping." + }, + { + "use": "optional", + "name": "MaximumNumberOfTLSCertificationPathValidationPolicies", + "type": "{http://www.w3.org/2001/XMLSchema}nonNegativeInteger", + "description": "Indicates the maximum number of certification path validation policies that may be assigned to the TLS server simultaneously." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities of the TLS server implementation." + }, + { + "name": "Dot1XCapabilities", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XCapabilities", + "type_name": "Dot1XCapabilities", + "definition": { + "kind": "complexType", + "name": "Dot1XCapabilities", + "description": "The capabilities of the 802.1X implementation on a device.", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "MaximumNumberOfDot1XConfigurations", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "description": "The maximum number of 802.1X configurations that may be defined simultaneously." + }, + { + "use": "optional", + "name": "Dot1XMethods", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XMethods", + "definition": { + "kind": "simpleType", + "name": "Dot1XMethods", + "description": "A list of supported 802.1X authentication methods, such as \"EAP-PEAP/MSCHAPv2\" and \"EAP-MD5\". The '/' character is used as a separator between the outer and inner methods.", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "The authentication methods supported by the 802.1X implementation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities of the 802.1X implementation." + }, + { + "name": "AuthorizationServer", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AuthorizationServerConfigurationCapabilities", + "type_name": "AuthorizationServerConfigurationCapabilities", + "definition": { + "kind": "complexType", + "name": "AuthorizationServerConfigurationCapabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "MaxConfigurations", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Indicates maximum number of authorization server configurations supported." + }, + { + "use": "optional", + "name": "ConfigurationTypesSupported", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Enumerates the supported authorization server configuration types, see tas:AuthorizationServerConfigurationType." + }, + { + "use": "optional", + "name": "ClientAuthenticationMethodsSupported", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Enumerates the supported client authentication methods, see tas:ClientAuthenticationMethod." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for external authorization server capabilities." + }, + { + "name": "MediaSigning", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}MediaSigningCapabilities", + "type_name": "MediaSigningCapabilities", + "definition": { + "kind": "complexType", + "name": "MediaSigningCapabilities", + "description": "The capabilities for signing media on a device.", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "MediaSigningSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether the device supports signing of media according to the Media Signing Specification." + }, + { + "use": "optional", + "name": "UserMediaSigningKeySupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether the device supports signing of media using another key than the factory provisioned one." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities of the media signing implementation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the security configuration service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AdvancedSecurityServiceBinding" + }, + { + "name": "GetJWTConfiguration", + "port_type": "JWT", + "description": "This operation returns the parameters of the JWT authorization used by the device.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetJWTConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetJWTConfiguration", + "schema": { + "name": "GetJWTConfiguration", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetJWTConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetJWTConfigurationResponse", + "schema": { + "name": "GetJWTConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}JWTConfiguration", + "type_name": "JWTConfiguration", + "definition": { + "kind": "complexType", + "name": "JWTConfiguration", + "fields": [ + { + "name": "Audiences", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported aud claims. A JWT must contain at least one of these." + }, + { + "name": "TrustedIssuers", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "If present, this is the list to URIs pointing to the metadata file conforming to RFC8414, such as \"https://your.domain/.well-known/openid-configuration\" , of the trusted Open ID Connect servers issuing JWT tokens. Using metadata, the device can reach the information about the JWKS and implement the rotation of the keys accordingly." + }, + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "If present, this is the list of keys provided out of band to verify the origin and integrity of the JWT." + }, + { + "name": "ValidationPolicy", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If present, the device will validate the certification path of the Open ID Connect servers. The OIDC server iso considered to be valid if its certificate is validated by the provided certification path validation policy." + }, + { + "name": "CustomClaims", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CustomClaim", + "type_name": "CustomClaim", + "definition": { + "kind": "complexType", + "name": "CustomClaim", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Custom claim name." + }, + { + "name": "SupportedValues", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported custom claim values. A JWT must contain at least one of these." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of optional custom claims to be used for JWT validation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "JWTBinding" + }, + { + "name": "SetJWTConfiguration", + "port_type": "JWT", + "description": "This operation sets the parameters of the JWT authorization used by the device.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetJWTConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetJWTConfiguration", + "schema": { + "name": "SetJWTConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}JWTConfiguration", + "type_name": "JWTConfiguration", + "definition": { + "kind": "complexType", + "name": "JWTConfiguration", + "fields": [ + { + "name": "Audiences", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported aud claims. A JWT must contain at least one of these." + }, + { + "name": "TrustedIssuers", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "If present, this is the list to URIs pointing to the metadata file conforming to RFC8414, such as \"https://your.domain/.well-known/openid-configuration\" , of the trusted Open ID Connect servers issuing JWT tokens. Using metadata, the device can reach the information about the JWKS and implement the rotation of the keys accordingly." + }, + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "If present, this is the list of keys provided out of band to verify the origin and integrity of the JWT." + }, + { + "name": "ValidationPolicy", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If present, the device will validate the certification path of the Open ID Connect servers. The OIDC server iso considered to be valid if its certificate is validated by the provided certification path validation policy." + }, + { + "name": "CustomClaims", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CustomClaim", + "type_name": "CustomClaim", + "definition": { + "kind": "complexType", + "name": "CustomClaim", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Custom claim name." + }, + { + "name": "SupportedValues", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported custom claim values. A JWT must contain at least one of these." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of optional custom claims to be used for JWT validation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetJWTConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetJWTConfigurationResponse", + "schema": { + "name": "SetJWTConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "JWTBinding" + }, + { + "name": "CreateRSAKeyPair", + "port_type": "Keystore", + "description": "This operation triggers the asynchronous generation of an RSA key pair of a particular key length (specified as the number of bits) as specified in [RFC 3447], with a suitable key generation mechanism on the device. Keys, especially RSA key pairs, are uniquely identified using key IDs. If the device does not have not enough storage capacity for storing the key pair to be created, the maximum number of keys reached fault shall be produced and no key pair shall be generated. Otherwise, the operation generates a keyID for the new key and associates the generating status to it. Immediately after key generation has started, the device shall return the keyID to the client and continue to generate the key pair. The client may query the device with the GetKeyStatus operation whether the generation has finished. The client may also subscribe to Key Status events to be notified about key status changes. The device also returns a best-effort estimate of how much time it requires to create the key pair. A client may use this information as an indication how long to wait before querying the device whether key generation is completed. After the key has been successfully created, the device shall assign it the ok status. If the key generation fails, the device shall assign the key the corrupt status.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateRSAKeyPairRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateRSAKeyPair", + "schema": { + "name": "CreateRSAKeyPair", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "KeyLength", + "type": "{http://www.w3.org/2001/XMLSchema}nonNegativeInteger", + "type_name": "nonNegativeInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The length of the key to be created." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the key." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateRSAKeyPairResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateRSAKeyPairResponse", + "schema": { + "name": "CreateRSAKeyPairResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The key ID of the key pair being generated." + }, + { + "name": "EstimatedCreationTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Best-effort estimate of how long the key generation will take." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "CreateECCKeyPair", + "port_type": "Keystore", + "description": "This operation triggers the asynchronous generation of an ECC key pair using a particular elliptic curve as specified in [RFC 8422], with a suitable key generation mechanism on the device. Keys, especially ECC key pairs, are uniquely identified using key IDs. If the device does not have not enough storage capacity for storing the key pair to be created, the maximum number of keys reached fault shall be produced and no key pair shall be generated. Otherwise, the operation generates a keyID for the new key and associates the generating status to it. Immediately after key generation has started, the device shall return the keyID to the client and continue to generate the key pair. The client may query the device with the GetKeyStatus operation whether the generation has finished. The client may also subscribe to Key Status events to be notified about key status changes. The device also returns a best-effort estimate of how much time it requires to create the key pair. A client may use this information as an indication how long to wait before querying the device whether key generation is completed. After the key has been successfully created, the device shall assign it the ok status. If the key generation fails, the device shall assign the key the corrupt status.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateECCKeyPairRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateECCKeyPair", + "schema": { + "name": "CreateECCKeyPair", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "EllipticCurve", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the elliptic curve to be used for generating the ECC keypair. Supported curve names can be found in the IANA TLS Supported Groups section, under the Description field." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the key." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateECCKeyPairResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateECCKeyPairResponse", + "schema": { + "name": "CreateECCKeyPairResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The key ID of the key pair being generated." + }, + { + "name": "EstimatedCreationTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Best-effort estimate of how long the key generation will take." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "UploadKeyPairInPKCS8", + "port_type": "Keystore", + "description": "Deprecated method for uploading a key pair in a PKCS#8 data structure as specified in [RFC 5958, RFC 5959]. If an encryption passphrase ID is supplied in the request, the device shall assume that the KeyPair parameter contains an EncryptedPrivateKeyInfo ASN.1 structure that is encrypted under the passphrase in the keystore that corresponds to the supplied ID, where the EncryptedPrivateKeyInfo structure contains both the private key and the corresponding public key. If no encryption passphrase ID is supplied, the device shall assume that the KeyPair parameter contains a OneAsymmetricKey ASN.1 structure which contains both the private key and the corresponding public key.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadKeyPairInPKCS8Request", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadKeyPairInPKCS8", + "schema": { + "name": "UploadKeyPairInPKCS8", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "KeyPair", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The key pair to be uploaded in a PKCS#8 data structure." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the key pair." + }, + { + "name": "EncryptionPassphraseID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}PassphraseID", + "type_name": "PassphraseID", + "definition": { + "kind": "simpleType", + "name": "PassphraseID", + "description": "Unique identifier for passphrases in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the passphrase to use for decrypting the uploaded key pair." + }, + { + "name": "EncryptionPassphrase", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The passphrase to use for decrypting the uploaded key pair." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadKeyPairInPKCS8Response", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadKeyPairInPKCS8Response", + "schema": { + "name": "UploadKeyPairInPKCS8Response", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The key ID of the uploaded key pair." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "UploadCertificateWithPrivateKeyInPKCS12", + "port_type": "Keystore", + "description": "This operation uploads a certification path consisting of X.509 certificates as specified by [RFC 5280] in DER encoding along with a private key to a device’s keystore. Certificates and private key are supplied in the form of a PKCS#12 file as specified in [PKCS#12]. The device shall support PKCS#12 files that contain the following safe bags: * one or more instances of CertBag [PKCS#12, Sect. 4.2.3] * either exactly one instance of KeyBag [PKCS#12, Sect. 4.3.1] or exactly one instance of PKCS8ShroudedKeyBag [PKCS#12, Sect. 4.2.2]. If the IgnoreAdditionalCertificates parameter has the value true, the device shall behave as if the client had supplied only the first CertBag in the sequence of CertBag instances. The device shall support PKCS#12 passphrase integrity mode for integrity protection of the PKCS#12 PFX as specified in [PKCS#12, Sect. 4]. The device shall support PKCS8ShroudedKeyBags that are encrypted with the same passphrase as the CertBag instances. If an integrity passphrase ID is supplied, the device shall use the corresponding passphrase in the keystore to check the integrity of the supplied PKCS#12 PFX. If an integrity passphrase ID is supplied, but the supplied PKCS#12 PFX has no integrity protection, the device shall produce a BadPKCS12File fault and shall not store the uploaded certificates nor the uploaded key pair in the keystore. If an encryption passphrase ID is supplied, the device shall use the corresponding passphrase in the keystore to decrypt the PKCS8ShroudedKeyBag and the CertBag instances. If an EncryptionPassphraseID is supplied, but a CertBag is not encrypted, the device shall ignore the supplied EncryptionPassphraseID when processing this CertBag. If an EncryptionPassphraseID is supplied, but a KeyBag is provided instead of a PKCS8ShroudedKeyBag, the device shall ignore the supplied EncryptionPassphraseID when processing the KeyBag.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadCertificateWithPrivateKeyInPKCS12Request", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadCertificateWithPrivateKeyInPKCS12", + "schema": { + "name": "UploadCertificateWithPrivateKeyInPKCS12", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertWithPrivateKey", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The certificates and key pair to be uploaded in a PKCS#12 data structure." + }, + { + "name": "CertificationPathAlias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the certification path." + }, + { + "name": "KeyAlias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the key pair." + }, + { + "name": "IgnoreAdditionalCertificates", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if the device shall behave as if the client had only supplied the first certificate in the sequence of certificates.", + "default": "false" + }, + { + "name": "IntegrityPassphraseID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}PassphraseID", + "type_name": "PassphraseID", + "definition": { + "kind": "simpleType", + "name": "PassphraseID", + "description": "Unique identifier for passphrases in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the passphrase to use for integrity checking of the uploaded PKCS#12 data structure." + }, + { + "name": "EncryptionPassphraseID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}PassphraseID", + "type_name": "PassphraseID", + "definition": { + "kind": "simpleType", + "name": "PassphraseID", + "description": "Unique identifier for passphrases in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the passphrase to use for decrypting the PKCS8ShroudedKeyBag and the CertBag instances." + }, + { + "name": "Passphrase", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The passphrase to use for integrity checking and decrypting the uploaded PKCS#12 data structure." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadCertificateWithPrivateKeyInPKCS12Response", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadCertificateWithPrivateKeyInPKCS12Response", + "schema": { + "name": "UploadCertificateWithPrivateKeyInPKCS12Response", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The certification path ID of the uploaded certification path." + }, + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The key ID of the uploaded key pair." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "GetKeyStatus", + "port_type": "Keystore", + "description": "This operation returns the status of a key. Keys are uniquely identified using key IDs. If no key is stored under the requested key ID in the keystore, an InvalidKeyID fault is produced. Otherwise, the status of the key is returned.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetKeyStatusRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetKeyStatus", + "schema": { + "name": "GetKeyStatus", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the key for which to return the status." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetKeyStatusResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetKeyStatusResponse", + "schema": { + "name": "GetKeyStatusResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "KeyStatus", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Status of the requested key. The value should be one of the values in the tas:KeyStatus enumeration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "GetPrivateKeyStatus", + "port_type": "Keystore", + "description": "This operation returns whether a key pair contains a private key. Keys are uniquely identified using key IDs. If no key is stored under the requested key ID in the keystore or the key identified by the requested key ID does not identify a key pair, the device shall produce an InvalidKeyID fault. Otherwise, this operation returns true if the key pair identified by the key ID contains a private key, and false otherwise.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetPrivateKeyStatusRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetPrivateKeyStatus", + "schema": { + "name": "GetPrivateKeyStatus", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the key pair for which to return whether it contains a private key." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetPrivateKeyStatusResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetPrivateKeyStatusResponse", + "schema": { + "name": "GetPrivateKeyStatusResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "hasPrivateKey", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if the key pair contains a private key." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "GetAllKeys", + "port_type": "Keystore", + "description": "This operation returns information about all keys that are stored in the device’s keystore. This operation may be used, e.g., if a client lost track of which keys are present on the device. If no key is stored on the device, an empty list is returned.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllKeysRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllKeys", + "schema": { + "name": "GetAllKeys", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllKeysResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllKeysResponse", + "schema": { + "name": "GetAllKeysResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "KeyAttribute", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyAttribute", + "type_name": "KeyAttribute", + "definition": { + "kind": "complexType", + "name": "KeyAttribute", + "description": "The attributes of a key in the keystore.", + "fields": [ + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the key." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the key." + }, + { + "name": "hasPrivateKey", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Absent if the key is not a key pair. True if and only if the key is a key pair and contains a private key. False if and only if the key is a key pair and does not contain a private key." + }, + { + "name": "KeyStatus", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The status of the key. The value should be one of the values in the tas:KeyStatus enumeration." + }, + { + "name": "externallyGenerated", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if the key was generated outside the device." + }, + { + "name": "securelyStored", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if the key is stored in a specially protected hardware component inside the device." + }, + { + "name": "Extension", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Information about a key in the keystore." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "DeleteKey", + "port_type": "Keystore", + "description": "This operation deletes a key from the device’s keystore. Keys are uniquely identified using key IDs. If no key is stored under the requested key ID in the keystore, a device shall produce an InvalidArgVal fault. If a reference exists for the specified key, a device shall produce the corresponding fault and shall not delete the key. If there is a key under the requested key ID stored in the keystore and the key could not be deleted, a device shall produce a KeyDeletion fault. If the key has the status generating, a device shall abort the generation of the key and delete from the keystore all data generated for this key. After a key is successfully deleted, the device may assign its former ID to other keys.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteKeyRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteKey", + "schema": { + "name": "DeleteKey", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the key that is to be deleted from the keystore." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteKeyResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteKeyResponse", + "schema": { + "name": "DeleteKeyResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "CreatePKCS10CSR", + "port_type": "Keystore", + "description": "This operation generates a DER-encoded PKCS#10 v1.7 certification request (sometimes also called certificate signing request or CSR) as specified in RFC 2986 for a public key on the device. The key pair that contains the public key for which a certification request shall be produced is specified by its key ID. If no key is stored under the requested KeyID or the key specified by the requested KeyID is not an asymmetric key pair, an invalid key ID fault shall be produced and no CSR shall be generated. A device that supports this command shall as minimum support the sha-1WithRSAEncryption signature algorithm as specified in RFC 3279. If the specified signature algorithm is not supported by the device, an UnsupportedSignatureAlgorithm fault shall be produced and no CSR shall be generated. If the public key identified by the requested Key ID is an invalid input to the specified signature algorithm, a KeySignatureAlgorithmMismatch fault shall be produced and no CSR shall be generated. If the key pair does not have status ok, a device shall produce an InvalidKeyStatus fault and no CSR shall be generated.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreatePKCS10CSRRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreatePKCS10CSR", + "schema": { + "name": "CreatePKCS10CSR", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Subject", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DistinguishedName", + "type_name": "DistinguishedName", + "definition": { + "kind": "complexType", + "name": "DistinguishedName", + "fields": [ + { + "name": "Country", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A country name as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "Organization", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "An organization name as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "OrganizationalUnit", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "An organizational unit name as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "DistinguishedNameQualifier", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A distinguished name qualifier as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "StateOrProvinceName", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A state or province name as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "CommonName", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A common name as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "SerialNumber", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A serial number as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "Locality", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A locality as specified in X.500." + }, + { + "name": "Title", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A title as specified in X.500." + }, + { + "name": "Surname", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A surname as specified in X.500." + }, + { + "name": "GivenName", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A given name as specified in X.500." + }, + { + "name": "Initials", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Initials as specified in X.500." + }, + { + "name": "Pseudonym", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A pseudonym as specified in X.500." + }, + { + "name": "GenerationQualifier", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A generation qualifier as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "GenericAttribute", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeTypeAndValue", + "type_name": "DNAttributeTypeAndValue", + "definition": { + "kind": "complexType", + "name": "DNAttributeTypeAndValue", + "description": "A distinguished name attribute type and value pair.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeType", + "type_name": "DNAttributeType", + "definition": { + "kind": "simpleType", + "name": "DNAttributeType", + "description": "The distinguished name attribute type encoded as specified in RFC 4514.", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The attribute type." + }, + { + "name": "Value", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the attribute." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A generic type-value pair\n\t\t\t\t\t\t\t\tattribute." + }, + { + "name": "MultiValuedRDN", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}MultiValuedRDN", + "type_name": "MultiValuedRDN", + "definition": { + "kind": "complexType", + "name": "MultiValuedRDN", + "description": "A multi-valued RDN", + "fields": [ + { + "name": "Attribute", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeTypeAndValue", + "type_name": "DNAttributeTypeAndValue", + "definition": { + "kind": "complexType", + "name": "DNAttributeTypeAndValue", + "description": "A distinguished name attribute type and value pair.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeType", + "type_name": "DNAttributeType", + "definition": { + "kind": "simpleType", + "name": "DNAttributeType", + "description": "The distinguished name attribute type encoded as specified in RFC 4514.", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The attribute type." + }, + { + "name": "Value", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the attribute." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of types and values defining a multi-valued RDN" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A multi-valued RDN" + }, + { + "name": "anyAttribute", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DomainComponent", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Domain Component as specified in RFC3739" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Required extension point. It is recommended to not use this element, and instead use GenericAttribute and the numeric Distinguished Name Attribute Type." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The subject to be included in the CSR." + }, + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the key for which the CSR shall be created." + }, + { + "name": "CSRAttribute", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CSRAttribute", + "type_name": "CSRAttribute", + "definition": { + "kind": "complexType", + "name": "CSRAttribute", + "description": "A CSR attribute as specified in PKCS#10.", + "fields": [ + { + "name": "X509v3Extension", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}X509v3Extension", + "type_name": "X509v3Extension", + "definition": { + "kind": "complexType", + "name": "X509v3Extension", + "description": "An X.509v3 extension field as specified in RFC 5280", + "fields": [ + { + "name": "extnOID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DotDecimalOID", + "type_name": "DotDecimalOID", + "definition": { + "kind": "simpleType", + "name": "DotDecimalOID", + "description": "An object identifier (OID) in dot-decimal form as specified in RFC4512.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "[0-9]+(.[0-9]+)*" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The OID of the extension field." + }, + { + "name": "critical", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if the extension is critical.", + "default": "false" + }, + { + "name": "extnValue", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the extension field as a base64-encoded DER representation of an ASN.1 value." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "An X.509v3 extension field." + }, + { + "name": "BasicRequestAttribute", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}BasicRequestAttribute", + "type_name": "BasicRequestAttribute", + "definition": { + "kind": "complexType", + "name": "BasicRequestAttribute", + "description": "A CSR attribute as specified in RFC 2986.", + "fields": [ + { + "name": "OID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DotDecimalOID", + "type_name": "DotDecimalOID", + "definition": { + "kind": "simpleType", + "name": "DotDecimalOID", + "description": "An object identifier (OID) in dot-decimal form as specified in RFC4512.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "[0-9]+(.[0-9]+)*" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The OID of the attribute." + }, + { + "name": "value", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the attribute as a base64-encoded DER representation of an ASN.1 value." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A basic CSR attribute." + }, + { + "name": "anyAttribute", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "An attribute to be included in the CSR." + }, + { + "name": "SignatureAlgorithm", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AlgorithmIdentifier", + "type_name": "AlgorithmIdentifier", + "definition": { + "kind": "complexType", + "name": "AlgorithmIdentifier", + "description": "An identifier of an algorithm.", + "fields": [ + { + "name": "algorithm", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DotDecimalOID", + "type_name": "DotDecimalOID", + "definition": { + "kind": "simpleType", + "name": "DotDecimalOID", + "description": "An object identifier (OID) in dot-decimal form as specified in RFC4512.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "[0-9]+(.[0-9]+)*" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The OID of the algorithm in dot-decimal form." + }, + { + "name": "parameters", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameters of the algorithm (depending on the algorithm)." + }, + { + "name": "anyParameters", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The signature algorithm to be used to sign the CSR." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreatePKCS10CSRResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreatePKCS10CSRResponse", + "schema": { + "name": "CreatePKCS10CSRResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PKCS10CSR", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The DER encoded PKCS#10 certification request." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "CreateSelfSignedCertificate", + "port_type": "Keystore", + "description": "This operation generates for a public key on the device a self-signed X.509 certificate that complies to RFC 5280. The X509Version parameter specifies the version of X.509 that the generated certificate shall comply to. A device that supports this command shall support the generation of X.509v3 certificates as specified in RFC 5280 and may additionally be able to handle other X.509 certificate formats as indicated by the X.509Versions capability. The key pair that contains the public key for which a self-signed certificate shall be produced is specified by its key pair ID. The subject parameter describes the entity that the public key belongs to. If the key pair does not have status ok, a device shall produce an InvalidKeyStatus fault and no certificate shall be generated. The signature algorithm parameter determines which signature algorithm shall be used for signing the certification request with the public key specified by the key ID parameter. A device that supports this command shall as minimum support the sha-1WithRSAEncryption signature algorithm as specified in RFC 3279. The Extensions parameter specifies potential X509v3 extensions that shall be contained in the certificate. A device that supports this command shall support the extensions that are defined in [RFC 5280], Sect. 4.2] as mandatory for CAs that issue self-signed certificates. Certificates are uniquely identified using certificate IDs. If the command was successful, the device generates a new ID for the generated certificate and returns this ID. If the device does not have not enough storage capacity for storing the certificate to be created, the maximum number of certificates reached fault shall be produced and no certificate shall be generated.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateSelfSignedCertificateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateSelfSignedCertificate", + "schema": { + "name": "CreateSelfSignedCertificate", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "X509Version", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The X.509 version that the generated certificate shall comply to." + }, + { + "name": "Subject", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DistinguishedName", + "type_name": "DistinguishedName", + "definition": { + "kind": "complexType", + "name": "DistinguishedName", + "fields": [ + { + "name": "Country", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A country name as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "Organization", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "An organization name as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "OrganizationalUnit", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "An organizational unit name as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "DistinguishedNameQualifier", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A distinguished name qualifier as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "StateOrProvinceName", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A state or province name as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "CommonName", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A common name as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "SerialNumber", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A serial number as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "Locality", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A locality as specified in X.500." + }, + { + "name": "Title", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A title as specified in X.500." + }, + { + "name": "Surname", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A surname as specified in X.500." + }, + { + "name": "GivenName", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A given name as specified in X.500." + }, + { + "name": "Initials", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Initials as specified in X.500." + }, + { + "name": "Pseudonym", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A pseudonym as specified in X.500." + }, + { + "name": "GenerationQualifier", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A generation qualifier as specified in\n\t\t\t\t\t\t\t\tX.500." + }, + { + "name": "GenericAttribute", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeTypeAndValue", + "type_name": "DNAttributeTypeAndValue", + "definition": { + "kind": "complexType", + "name": "DNAttributeTypeAndValue", + "description": "A distinguished name attribute type and value pair.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeType", + "type_name": "DNAttributeType", + "definition": { + "kind": "simpleType", + "name": "DNAttributeType", + "description": "The distinguished name attribute type encoded as specified in RFC 4514.", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The attribute type." + }, + { + "name": "Value", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the attribute." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A generic type-value pair\n\t\t\t\t\t\t\t\tattribute." + }, + { + "name": "MultiValuedRDN", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}MultiValuedRDN", + "type_name": "MultiValuedRDN", + "definition": { + "kind": "complexType", + "name": "MultiValuedRDN", + "description": "A multi-valued RDN", + "fields": [ + { + "name": "Attribute", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeTypeAndValue", + "type_name": "DNAttributeTypeAndValue", + "definition": { + "kind": "complexType", + "name": "DNAttributeTypeAndValue", + "description": "A distinguished name attribute type and value pair.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeType", + "type_name": "DNAttributeType", + "definition": { + "kind": "simpleType", + "name": "DNAttributeType", + "description": "The distinguished name attribute type encoded as specified in RFC 4514.", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The attribute type." + }, + { + "name": "Value", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the attribute." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of types and values defining a multi-valued RDN" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A multi-valued RDN" + }, + { + "name": "anyAttribute", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DomainComponent", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DNAttributeValue", + "type_name": "DNAttributeValue", + "definition": { + "kind": "simpleType", + "name": "DNAttributeValue", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Domain Component as specified in RFC3739" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Required extension point. It is recommended to not use this element, and instead use GenericAttribute and the numeric Distinguished Name Attribute Type." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Distinguished name of the entity that the certificate shall belong to." + }, + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the key for which the certificate shall be created." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the certificate to be created." + }, + { + "name": "notValidBefore", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The X.509 not valid before information to be included in the certificate. Defaults to the device's current time or a time before the device's current time." + }, + { + "name": "notValidAfter", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The X.509 not valid after information to be included in the certificate. Defaults to the time 99991231235959Z as specified in RFC 5280." + }, + { + "name": "SignatureAlgorithm", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AlgorithmIdentifier", + "type_name": "AlgorithmIdentifier", + "definition": { + "kind": "complexType", + "name": "AlgorithmIdentifier", + "description": "An identifier of an algorithm.", + "fields": [ + { + "name": "algorithm", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DotDecimalOID", + "type_name": "DotDecimalOID", + "definition": { + "kind": "simpleType", + "name": "DotDecimalOID", + "description": "An object identifier (OID) in dot-decimal form as specified in RFC4512.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "[0-9]+(.[0-9]+)*" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The OID of the algorithm in dot-decimal form." + }, + { + "name": "parameters", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameters of the algorithm (depending on the algorithm)." + }, + { + "name": "anyParameters", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The signature algorithm to be used for signing the certificate." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}X509v3Extension", + "type_name": "X509v3Extension", + "definition": { + "kind": "complexType", + "name": "X509v3Extension", + "description": "An X.509v3 extension field as specified in RFC 5280", + "fields": [ + { + "name": "extnOID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DotDecimalOID", + "type_name": "DotDecimalOID", + "definition": { + "kind": "simpleType", + "name": "DotDecimalOID", + "description": "An object identifier (OID) in dot-decimal form as specified in RFC4512.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "[0-9]+(.[0-9]+)*" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The OID of the extension field." + }, + { + "name": "critical", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if the extension is critical.", + "default": "false" + }, + { + "name": "extnValue", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the extension field as a base64-encoded DER representation of an ASN.1 value." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "An X.509v3 extension to be included in the certificate." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateSelfSignedCertificateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateSelfSignedCertificateResponse", + "schema": { + "name": "CreateSelfSignedCertificateResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the generated certificate." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "UploadCertificate", + "port_type": "Keystore", + "description": "This operation uploads an X.509 certificate as specified by [RFC 5280] in DER encoding and the public key in the certificate to a device’s keystore. A device that supports this command shall be able to handle X.509v3 certificates as specified in RFC 5280 and may additionally be able to handle other X.509 certificate formats as indicated by the X.509Versions capability. A device that supports this command shall support sha1-WithRSAEncryption as certificate signature algorithm. Certificates are uniquely identified using certificate IDs, and key pairs are uniquely identified using key IDs. The device shall generate a new certificate ID for the uploaded certificate. Certain certificate usages, e.g. TLS server authentication, require the private key that corresponds to the public key in the certificate to be present in the keystore. In such cases, the client may indicate that it expects the device to produce a fault if the matching private key for the uploaded certificate is not present in the keystore by setting the PrivateKeyRequired argument in the upload request to true. The uploaded certificate has to be linked to a key pair in the keystore. If no private key is required for the public key in the certificate and a key pair exists in the keystore with a public key equal to the public key in the certificate, the uploaded certificate is linked to the key pair identified by the supplied key ID by adding a reference from the certificate to the key pair. If no private key is required for the public key in the certificate and no key pair exists with the public key equal to the public key in the certificate, a new key pair with status ok is created with the public key from the certificate, and this key pair is linked to the uploaded certificate by adding a reference from the certificate to the key pair. If a private key is required for the public key in the certificate, and a key pair exists in the keystore with a private key that matches the public key in the certificate, the uploaded certificate is linked to this keypair by adding a reference from the certificate to the key pair. If a private key is required for the public key and no such keypair exists in the keystore, the NoMatchingPrivateKey fault shall be produced and the certificate shall not be stored in the keystore. If the key pair that the certificate shall be linked to does not have status ok, an InvalidKeyID fault is produced, and the uploaded certificate is not stored in the keystore. If the device cannot process the uploaded certificate, a BadCertificate fault is produced and neither the uploaded certificate nor the public key are stored in the device’s keystore. The BadCertificate fault shall not be produced based on the mere fact that the device’s current time lies outside the interval defined by the notBefore and notAfter fields as specified by [RFC 5280], Sect. 4.1 . This operation shall not mark the uploaded certificate as trusted. If the device does not have not enough storage capacity for storing the certificate to be uploaded, the maximum number of certificates reached fault shall be produced and no certificate shall be uploaded. If the device does not have not enough storage capacity for storing the key pair that eventually has to be created, the device shall generate a maximum number of keys reached fault. Furthermore the device shall not generate a key pair and no certificate shall be stored.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadCertificateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadCertificate", + "schema": { + "name": "UploadCertificate", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Certificate", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The base64-encoded DER representation of the X.509 certificate to be uploaded." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the certificate." + }, + { + "name": "KeyAlias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the key pair." + }, + { + "name": "PrivateKeyRequired", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the device shall verify that a matching key pair with a private key exists in the keystore.", + "default": "false" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadCertificateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadCertificateResponse", + "schema": { + "name": "UploadCertificateResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the uploaded certificate." + }, + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the key that the uploaded certificate certifies." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "GetCertificate", + "port_type": "Keystore", + "description": "This operation returns a specific certificate from the device’s keystore. Certificates are uniquely identified using certificate IDs. If no certificate is stored under the requested certificate ID in the keystore, an InvalidArgVal fault is produced. It shall be noted that this command does not return the private key that is associated to the public key in the certificate.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCertificateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCertificate", + "schema": { + "name": "GetCertificate", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certificate to retrieve." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCertificateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCertificateResponse", + "schema": { + "name": "GetCertificateResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Certificate", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}X509Certificate", + "type_name": "X509Certificate", + "definition": { + "kind": "complexType", + "name": "X509Certificate", + "description": "An X.509 cerficiate as specified in RFC 5280.", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certificate." + }, + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the key that this certificate associates to the certificate subject." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the certificate." + }, + { + "name": "CertificateContent", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The base64-encoded DER representation of the X.509 certificate." + }, + { + "name": "HasPrivateKey", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The keystore has a matching private key." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The DER representation of the certificate." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "GetAllCertificates", + "port_type": "Keystore", + "description": "This operation returns the IDs of all certificates that are stored in the device’s keystore. This operation may be used, e.g., if a client lost track of which certificates are present on the device. If no certificate is stored in the device’s keystore, an empty list is returned.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCertificatesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCertificates", + "schema": { + "name": "GetAllCertificates", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCertificatesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCertificatesResponse", + "schema": { + "name": "GetAllCertificatesResponse", + "definition": { + "kind": "complexType", + "description": "A list with all certificates stored in the keystore.", + "fields": [ + { + "name": "Certificate", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}X509Certificate", + "type_name": "X509Certificate", + "definition": { + "kind": "complexType", + "name": "X509Certificate", + "description": "An X.509 cerficiate as specified in RFC 5280.", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certificate." + }, + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the key that this certificate associates to the certificate subject." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the certificate." + }, + { + "name": "CertificateContent", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The base64-encoded DER representation of the X.509 certificate." + }, + { + "name": "HasPrivateKey", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The keystore has a matching private key." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A certificate stored in the keystore." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "DeleteCertificate", + "port_type": "Keystore", + "description": "This operation deletes a certificate from the device’s keystore. The operation shall not delete the public key that is contained in the certificate from the keystore. Certificates are uniquely identified using certificate IDs. If no certificate is stored under the requested certificate ID in the keystore, an InvalidArgVal fault is produced. If there is a certificate under the requested certificate ID stored in the keystore and the certificate could not be deleted, a CertificateDeletion fault is produced. If a reference exists for the specified certificate, the certificate shall not be deleted and the corresponding fault shall be produced. After a certificate has been successfully deleted, the device may assign its former ID to other certificates.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCertificateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCertificate", + "schema": { + "name": "DeleteCertificate", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certificate to delete." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCertificateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCertificateResponse", + "schema": { + "name": "DeleteCertificateResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "CreateCertificationPath", + "port_type": "Keystore", + "description": "This operation creates a sequence of certificates that may be used, e.g., for certification path validation or for TLS server authentication. Certification paths are uniquely identified using certification path IDs. Certificates are uniquely identified using certificate IDs. A certification path contains a sequence of certificate IDs. If there is a certificate ID in the sequence of supplied certificate IDs for which no certificate exists in the device’s keystore, the corresponding fault shall be produced and no certification path shall be created. The signature of each certificate in the certification path except for the last one must be verifiable with the public key contained in the next certificate in the path. If there is a certificate ID in the request other than the last ID for which the corresponding certificate cannot be verified with the public key in the certificate identified by the next certificate ID, an InvalidCertificateChain fault shall be produced and no certification path shall be created.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateCertificationPathRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateCertificationPath", + "schema": { + "name": "CreateCertificationPath", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificateIDs", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateIDs", + "type_name": "CertificateIDs", + "definition": { + "kind": "complexType", + "name": "CertificateIDs", + "description": "A sequence of certificate IDs.", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A certificate ID." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The IDs of the certificates to include in the certification path, where each certificate signature except for the last one in the path must be verifiable with the public key certified by the next certificate in the path." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the certification path." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateCertificationPathResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateCertificationPathResponse", + "schema": { + "name": "CreateCertificationPathResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the generated certification path." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "GetCertificationPath", + "port_type": "Keystore", + "description": "This operation returns a specific certification path from the device’s keystore. Certification paths are uniquely identified using certification path IDs. If no certification path is stored under the requested ID in the keystore, an InvalidArgVal fault is produced.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCertificationPathRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCertificationPath", + "schema": { + "name": "GetCertificationPath", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certification path to retrieve." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCertificationPathResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCertificationPathResponse", + "schema": { + "name": "GetCertificationPathResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificationPath", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPath", + "type_name": "CertificationPath", + "definition": { + "kind": "complexType", + "name": "CertificationPath", + "description": "An X.509 certification path as defined in RFC 5280.", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A certificate in the certification path." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the certification path." + }, + { + "name": "anyElement", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The certification path that is stored under the given ID in the keystore." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "GetAllCertificationPaths", + "port_type": "Keystore", + "description": "This operation returns the IDs of all certification paths that are stored in the device’s keystore. This operation may be used, e.g., if a client lost track of which certificates are present on the device. If no certification path is stored on the device, an empty list is returned.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCertificationPathsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCertificationPaths", + "schema": { + "name": "GetAllCertificationPaths", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCertificationPathsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCertificationPathsResponse", + "schema": { + "name": "GetAllCertificationPathsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "An ID of a certification path in the keystore." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "SetCertificationPath", + "port_type": "Keystore", + "description": "This operation allows to modify a certification path.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetCertificationPathRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetCertificationPath", + "schema": { + "name": "SetCertificationPath", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certification path to be modidfied." + }, + { + "name": "CertificationPath", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPath", + "type_name": "CertificationPath", + "definition": { + "kind": "complexType", + "name": "CertificationPath", + "description": "An X.509 certification path as defined in RFC 5280.", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A certificate in the certification path." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the certification path." + }, + { + "name": "anyElement", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The updated certification path to be stored in the keystore." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetCertificationPathResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetCertificationPathResponse", + "schema": { + "name": "SetCertificationPathResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "DeleteCertificationPath", + "port_type": "Keystore", + "description": "This operation deletes a certification path from the device’s keystore. This operation shall not delete the certificates that are referenced by the certification path. Certification paths are uniquely identified using certification path IDs. If no certification path is stored under the requested certification path ID in the keystore, an InvalidArgVal fault is produced. If there is a certification path under the requested certification path ID stored in the keystore and the certification path could not be deleted, a CertificationPathDeletion fault is produced. If a reference exists for the specified certification path, the certification path shall not be deleted and the corresponding fault shall be produced. After a certification path is successfully deleted, the device may assign its former ID to other certification paths.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCertificationPathRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCertificationPath", + "schema": { + "name": "DeleteCertificationPath", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certification path to delete." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCertificationPathResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCertificationPathResponse", + "schema": { + "name": "DeleteCertificationPathResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "UploadPassphrase", + "port_type": "Keystore", + "description": "This operation uploads a passphrase to the keystore of the device.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadPassphraseRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadPassphrase", + "schema": { + "name": "UploadPassphrase", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Passphrase", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The passphrase to upload." + }, + { + "name": "PassphraseAlias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The alias for the passphrase to upload." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadPassphraseResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadPassphraseResponse", + "schema": { + "name": "UploadPassphraseResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PassphraseID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}PassphraseID", + "type_name": "PassphraseID", + "definition": { + "kind": "simpleType", + "name": "PassphraseID", + "description": "Unique identifier for passphrases in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The PassphraseID of the uploaded passphrase." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "GetAllPassphrases", + "port_type": "Keystore", + "description": "This operation returns information about all passphrases that are stored in the keystore of the device. This operation may be used, e.g., if a client lost track of which passphrases are present on the device. If no passphrase is stored on the device, the device shall return an empty list.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllPassphrasesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllPassphrases", + "schema": { + "name": "GetAllPassphrases", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllPassphrasesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllPassphrasesResponse", + "schema": { + "name": "GetAllPassphrasesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PassphraseAttribute", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}PassphraseAttribute", + "type_name": "PassphraseAttribute", + "definition": { + "kind": "complexType", + "name": "PassphraseAttribute", + "fields": [ + { + "name": "PassphraseID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}PassphraseID", + "type_name": "PassphraseID", + "definition": { + "kind": "simpleType", + "name": "PassphraseID", + "description": "Unique identifier for passphrases in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the passphrase." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The alias of the passphrase." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Information about a passphrase in the keystore." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "DeletePassphrase", + "port_type": "Keystore", + "description": "This operation deletes a passphrase from the keystore of the device.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeletePassphraseRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeletePassphrase", + "schema": { + "name": "DeletePassphrase", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PassphraseID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}PassphraseID", + "type_name": "PassphraseID", + "definition": { + "kind": "simpleType", + "name": "PassphraseID", + "description": "Unique identifier for passphrases in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the passphrase that is to be deleted from the keystore." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeletePassphraseResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeletePassphraseResponse", + "schema": { + "name": "DeletePassphraseResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "UploadCRL", + "port_type": "Keystore", + "description": "This operation uploads a certificate revocation list (CRL) as specified in [RFC 5280] to the keystore on the device. If the device does not have enough storage space to store the CRL to be uploaded, the device shall produce a MaximumNumberOfCRLsReached fault and shall not store the supplied CRL. If the device is not able to process the supplied CRL, the device shall produce a BadCRL fault and shall not store the supplied CRL. If the device does not support the signature algorithm that was used to sign the supplied CRL, the device shall produce an UnsupportedSignatureAlgorithm fault and shall not store the supplied CRL.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadCRLRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadCRL", + "schema": { + "name": "UploadCRL", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Crl", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The CRL to be uploaded to the device." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The alias to assign to the uploaded CRL." + }, + { + "name": "anyParameters", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadCRLResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}UploadCRLResponse", + "schema": { + "name": "UploadCRLResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CrlID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CRLID", + "type_name": "CRLID", + "definition": { + "kind": "simpleType", + "name": "CRLID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the uploaded CRL." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "GetCRL", + "port_type": "Keystore", + "description": "This operation returns a specific certificate revocation list (CRL) from the keystore on the device. Certification revocation lists are uniquely identified using CRLIDs. If no CRL is stored under the requested CRLID, the device shall produce a CRLID fault.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCRLRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCRL", + "schema": { + "name": "GetCRL", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CrlID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CRLID", + "type_name": "CRLID", + "definition": { + "kind": "simpleType", + "name": "CRLID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the CRL to be returned." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCRLResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCRLResponse", + "schema": { + "name": "GetCRLResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Crl", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CRL", + "type_name": "CRL", + "definition": { + "kind": "complexType", + "name": "CRL", + "fields": [ + { + "name": "CRLID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CRLID", + "type_name": "CRLID", + "definition": { + "kind": "simpleType", + "name": "CRLID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "CRLContent", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The CRL with the requested ID." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "GetAllCRLs", + "port_type": "Keystore", + "description": "This operation returns all certificate revocation lists (CRLs) that are stored in the keystore on the device. If no certificate revocation list is stored in the device’s keystore, an empty list is returned.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCRLsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCRLs", + "schema": { + "name": "GetAllCRLs", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCRLsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCRLsResponse", + "schema": { + "name": "GetAllCRLsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Crl", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CRL", + "type_name": "CRL", + "definition": { + "kind": "complexType", + "name": "CRL", + "fields": [ + { + "name": "CRLID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CRLID", + "type_name": "CRLID", + "definition": { + "kind": "simpleType", + "name": "CRLID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "CRLContent", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Base64DERencodedASN1Value", + "type_name": "Base64DERencodedASN1Value", + "definition": { + "kind": "simpleType", + "name": "Base64DERencodedASN1Value", + "description": "A base64-encoded ASN.1 value.", + "base": "{http://www.w3.org/2001/XMLSchema}base64Binary" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of all CRLs that are stored in the keystore on the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "DeleteCRL", + "port_type": "Keystore", + "description": "This operation deletes a certificate revocation list (CRL) from the keystore on the device. Certification revocation lists are uniquely identified using CRLIDs. If no CRL is stored under the requested CRLID, the device shall produce a CRLID fault. If a reference exists for the specified CRL, the device shall produce a ReferenceExists fault and shall not delete the CRL. After a CRL has been successfully deleted, a device may assign its former ID to other CRLs.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCRLRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCRL", + "schema": { + "name": "DeleteCRL", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CrlID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CRLID", + "type_name": "CRLID", + "definition": { + "kind": "simpleType", + "name": "CRLID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the CRL to be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCRLResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCRLResponse", + "schema": { + "name": "DeleteCRLResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "CreateCertPathValidationPolicy", + "port_type": "Keystore", + "description": "This operation creates a certification path validation policy. Certification path validation policies are uniquely identified using certification path validation policy IDs. The device shall generate a new certification path validation policy ID for the created certification path validation policy. For the certification path validation parameters that are not represented in the certPathValidationParameters data type, the device shall use the default values specified in Sect. 3. If the device does not have enough storage capacity for storing the certification path validation policy to be created, the device shall produce a maximum number of certification path validation policies reached fault and shall not create a certification path validation policy. If there is at least one trust anchor certificate ID in the request for which there exists no certificate in the device’s keystore, the device shall produce a CertificateID fault and shall not create a certification path validation policy. If the device cannot process the supplied certification path validation parameters, the device shall produce a CertPathValidationParameters fault and shall not create a certification path validation policy.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateCertPathValidationPolicyRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateCertPathValidationPolicy", + "schema": { + "name": "CreateCertPathValidationPolicy", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The alias to assign to the created certification path validation policy." + }, + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationParameters", + "type_name": "CertPathValidationParameters", + "definition": { + "kind": "complexType", + "name": "CertPathValidationParameters", + "fields": [ + { + "name": "RequireTLSWWWClientAuthExtendedKeyUsage", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if the TLS server shall not authenticate client certificates that do not contain the TLS WWW client authentication key usage extension as specified in RFC 5280, Sect. 4.2.1.12.", + "default": "false" + }, + { + "name": "UseDeltaCRLs", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if delta CRLs, if available, shall be applied to CRLs.", + "default": "false" + }, + { + "name": "anyParameters", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The parameters of the certification path validation policy to be created." + }, + { + "name": "TrustAnchor", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}TrustAnchor", + "type_name": "TrustAnchor", + "definition": { + "kind": "complexType", + "name": "TrustAnchor", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The certificate ID of the certificate to be used as trust anchor." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "The trust anchors of the certification path validation policy to be created." + }, + { + "name": "anyParameters", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateCertPathValidationPolicyResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateCertPathValidationPolicyResponse", + "schema": { + "name": "CreateCertPathValidationPolicyResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the created certification path validation policy." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "GetCertPathValidationPolicy", + "port_type": "Keystore", + "description": "This operation returns a certification path validation policy from the keystore on the device. Certification path validation policies are uniquely identified using certification path validation policy IDs. If no certification path validation policy is stored under the requested certification path validation policy ID, the device shall produce a CertPathValidationPolicyID fault.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCertPathValidationPolicyRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCertPathValidationPolicy", + "schema": { + "name": "GetCertPathValidationPolicy", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certification path validation policy to be created." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCertPathValidationPolicyResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCertPathValidationPolicyResponse", + "schema": { + "name": "GetCertPathValidationPolicyResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertPathValidationPolicy", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicy", + "type_name": "CertPathValidationPolicy", + "definition": { + "kind": "complexType", + "name": "CertPathValidationPolicy", + "fields": [ + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationParameters", + "type_name": "CertPathValidationParameters", + "definition": { + "kind": "complexType", + "name": "CertPathValidationParameters", + "fields": [ + { + "name": "RequireTLSWWWClientAuthExtendedKeyUsage", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if the TLS server shall not authenticate client certificates that do not contain the TLS WWW client authentication key usage extension as specified in RFC 5280, Sect. 4.2.1.12.", + "default": "false" + }, + { + "name": "UseDeltaCRLs", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if delta CRLs, if available, shall be applied to CRLs.", + "default": "false" + }, + { + "name": "anyParameters", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TrustAnchor", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}TrustAnchor", + "type_name": "TrustAnchor", + "definition": { + "kind": "complexType", + "name": "TrustAnchor", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The certificate ID of the certificate to be used as trust anchor." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "anyParameters", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The certification path validation policy that is stored under the requested ID." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "GetAllCertPathValidationPolicies", + "port_type": "Keystore", + "description": "This operation returns all certification path validation policies that are stored in the keystore on the device. If no certification path validation policy is stored in the device’s keystore, an empty list is returned.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCertPathValidationPoliciesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCertPathValidationPolicies", + "schema": { + "name": "GetAllCertPathValidationPolicies", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCertPathValidationPoliciesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllCertPathValidationPoliciesResponse", + "schema": { + "name": "GetAllCertPathValidationPoliciesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertPathValidationPolicy", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicy", + "type_name": "CertPathValidationPolicy", + "definition": { + "kind": "complexType", + "name": "CertPathValidationPolicy", + "fields": [ + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationParameters", + "type_name": "CertPathValidationParameters", + "definition": { + "kind": "complexType", + "name": "CertPathValidationParameters", + "fields": [ + { + "name": "RequireTLSWWWClientAuthExtendedKeyUsage", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if the TLS server shall not authenticate client certificates that do not contain the TLS WWW client authentication key usage extension as specified in RFC 5280, Sect. 4.2.1.12.", + "default": "false" + }, + { + "name": "UseDeltaCRLs", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if delta CRLs, if available, shall be applied to CRLs.", + "default": "false" + }, + { + "name": "anyParameters", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TrustAnchor", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}TrustAnchor", + "type_name": "TrustAnchor", + "definition": { + "kind": "complexType", + "name": "TrustAnchor", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The certificate ID of the certificate to be used as trust anchor." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "anyParameters", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of all certification path validation policies that are stored in the keystore on the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "SetCertPathValidationPolicy", + "port_type": "Keystore", + "description": "This operation allows to modify an existing certification path validation policy.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetCertPathValidationPolicyRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetCertPathValidationPolicy", + "schema": { + "name": "SetCertPathValidationPolicy", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "This element is deprecated and ignored; the ID of the certification path validation policy being modified must be specified in the CertPathValidationPolicy structure." + }, + { + "name": "CertPathValidationPolicy", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicy", + "type_name": "CertPathValidationPolicy", + "definition": { + "kind": "complexType", + "name": "CertPathValidationPolicy", + "fields": [ + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationParameters", + "type_name": "CertPathValidationParameters", + "definition": { + "kind": "complexType", + "name": "CertPathValidationParameters", + "fields": [ + { + "name": "RequireTLSWWWClientAuthExtendedKeyUsage", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if the TLS server shall not authenticate client certificates that do not contain the TLS WWW client authentication key usage extension as specified in RFC 5280, Sect. 4.2.1.12.", + "default": "false" + }, + { + "name": "UseDeltaCRLs", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if and only if delta CRLs, if available, shall be applied to CRLs.", + "default": "false" + }, + { + "name": "anyParameters", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TrustAnchor", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}TrustAnchor", + "type_name": "TrustAnchor", + "definition": { + "kind": "complexType", + "name": "TrustAnchor", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The certificate ID of the certificate to be used as trust anchor." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "anyParameters", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The updated certification path validation policy to be stored." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetCertPathValidationPolicyResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetCertPathValidationPolicyResponse", + "schema": { + "name": "SetCertPathValidationPolicyResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "DeleteCertPathValidationPolicy", + "port_type": "Keystore", + "description": "This operation deletes a certification path validation policy from the keystore on the device. Certification path validation policies are uniquely identified using certification path validation policy IDs. If no certification path validation policy is stored under the requested certification path validation policy ID, the device shall produce an InvalidCertPathValidationPolicyID fault. If a reference exists for the requested certification path validation policy, the device shall produce a ReferenceExists fault and shall not delete the certification path validation policy. After the certification path validation policy has been deleted, the device may assign its former ID to other certification path validation policies.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCertPathValidationPolicyRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCertPathValidationPolicy", + "schema": { + "name": "DeleteCertPathValidationPolicy", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certification path validation policy to be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCertPathValidationPolicyResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteCertPathValidationPolicyResponse", + "schema": { + "name": "DeleteCertPathValidationPolicyResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "KeystoreBinding" + }, + { + "name": "AddServerCertificateAssignment", + "port_type": "TLSServer", + "description": "This operation assigns a key pair and certificate along with a certification path (certificate chain) to the TLS server on the device. The TLS server shall use this information for key exchange during the TLS handshake, particularly for constructing server certificate messages. Certification paths are identified by their certification path IDs in the keystore. The first certificate in the certification path must be the TLS server certificate. Since each certificate has exactly one associated key pair, a reference to the key pair that is associated with the server certificate is not supplied explicitly. Devices shall obtain the private key or results of operations under the private key by suitable internal interaction with the keystore. If a device chooses to perform a TLS key exchange based on the supplied certification path, it shall use the key pair that is associated with the server certificate for key exchange and transmit the certification path to TLS clients as-is. In order to use the server certificate during the TLS handshake, the corresponding private key is required. Therefore, if the key pair that is associated with the server certificate, i.e., the first certificate in the certification path, does not have an associated private key, the NoPrivateKey fault is produced and the certification path is not associated to the TLS server. A TLS server may present different certification paths to different clients during the TLS handshake instead of presenting the same certification path to all clients. Therefore more than one certification path may be assigned to the TLS server. If the maximum number of certification paths that may be assigned to the TLS server simultaneously is reached, the device shall generate a MaximumNumberOfCertificationPathsReached fault and the requested certification path shall not be assigned to the TLS server.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddServerCertificateAssignmentRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddServerCertificateAssignment", + "schema": { + "name": "AddServerCertificateAssignment", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddServerCertificateAssignmentResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddServerCertificateAssignmentResponse", + "schema": { + "name": "AddServerCertificateAssignmentResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "RemoveServerCertificateAssignment", + "port_type": "TLSServer", + "description": "This operation removes a key pair and certificate assignment (including certification path) to the TLS server on the device. Certification paths are identified using certification path IDs. If the supplied certification path ID is not associated to the TLS server, an InvalidArgVal fault is produced.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}RemoveServerCertificateAssignmentRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}RemoveServerCertificateAssignment", + "schema": { + "name": "RemoveServerCertificateAssignment", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}RemoveServerCertificateAssignmentResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}RemoveServerCertificateAssignmentResponse", + "schema": { + "name": "RemoveServerCertificateAssignmentResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "ReplaceServerCertificateAssignment", + "port_type": "TLSServer", + "description": "This operation replaces an existing key pair and certificate assignment to the TLS server on the device by a new key pair and certificate assignment (including certification paths). After the replacement, the TLS server shall use the new certificate and certification path exactly in those cases in which it would have used the old certificate and certification path. Therefore, especially in the case that several server certificates are assigned to the TLS server, clients that wish to replace an old certificate assignment by a new assignment should use this operation instead of a combination of the Add TLS Server Certificate Assignment and the Remove TLS Server Certificate Assignment operations. Certification paths are identified using certification path IDs. If the supplied old certification path ID is not associated to the TLS server, or no certification path exists under the new certification path ID, the corresponding InvalidArgVal faults are produced and the associations are unchanged. The first certificate in the new certification path must be the TLS server certificate. Since each certificate has exactly one associated key pair, a reference to the key pair that is associated with the new server certificate is not supplied explicitly. Devices shall obtain the private key or results of operations under the private key by suitable internal interaction with the keystore. If a device chooses to perform a TLS key exchange based on the new certification path, it shall use the key pair that is associated with the server certificate for key exchange and transmit the certification path to TLS clients as-is. In order to use the server certificate during the TLS handshake, the corresponding private key is required. Therefore, if the key pair that is associated with the server certificate, i.e., the first certificate in the certification path, does not have an associated private key, the NoPrivateKey fault is produced and the certification path is not associated to the TLS server.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}ReplaceServerCertificateAssignmentRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}ReplaceServerCertificateAssignment", + "schema": { + "name": "ReplaceServerCertificateAssignment", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OldCertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "NewCertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}ReplaceServerCertificateAssignmentResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}ReplaceServerCertificateAssignmentResponse", + "schema": { + "name": "ReplaceServerCertificateAssignmentResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "SetEnabledTLSVersions", + "port_type": "TLSServer", + "description": "This operation sets the version(s) of TLS which the device shall use. Valid values are taken from the TLSServerSupported capability. A client initiates a TLS session by sending a ClientHello with the hightest TLS version it supports. This suggests to the server that the client can accept any TLS version up to and including that version. The server then chooses the TLS version to use. This is generally the highest TLS version the server supports that is within the range of the client. For example, if a ClientHello indicates TLS version 1.1, the server can proceed with TLS 1.0 or TLS 1.1. In the event that an ONVIF installation wishes to disable certain version(s) of TLS, it may do so with this operation. For example, to disable TLS 1.0 on a device signaling support for TLS versions 1.0, 1.1, and 1.2, the enabled version list may be set to \"1.1 1.2\", omitting 1.0. If a client then attempts to connect with a ClientHello containing TLS 1.0, the server shall send a \"protocol_version\" alert message and close the connection. This handshake indicates to the client that TLS 1.0 is not supported by the server. The client must try again with a higher TLS version suggestion. An empty list is not permitted. Disabling all versions of TLS is not the intent of this operation. See AddServerCertificateAssignment and RemoveServerCertificateAssignment.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetEnabledTLSVersionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetEnabledTLSVersions", + "schema": { + "name": "SetEnabledTLSVersions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Versions", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}TLSVersions", + "type_name": "TLSVersions", + "definition": { + "kind": "simpleType", + "name": "TLSVersions", + "description": "A list of TLS versions.", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of TLS versions to allow." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetEnabledTLSVersionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetEnabledTLSVersionsResponse", + "schema": { + "name": "SetEnabledTLSVersionsResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "GetEnabledTLSVersions", + "port_type": "TLSServer", + "description": "This operation retrieves the version(s) of TLS which are currently enabled on the device.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetEnabledTLSVersionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetEnabledTLSVersions", + "schema": { + "name": "GetEnabledTLSVersions", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetEnabledTLSVersionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetEnabledTLSVersionsResponse", + "schema": { + "name": "GetEnabledTLSVersionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Versions", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}TLSVersions", + "type_name": "TLSVersions", + "definition": { + "kind": "simpleType", + "name": "TLSVersions", + "description": "A list of TLS versions.", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of allowed TLS versions." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "GetAssignedServerCertificates", + "port_type": "TLSServer", + "description": "This operation returns the IDs of all key pairs and certificates (including certification paths) that are assigned to the TLS server on the device. This operation may be used, e.g., if a client lost track of the certification path assignments on the device. If no certification path is assigned to the TLS server, an empty list is returned.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAssignedServerCertificatesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAssignedServerCertificates", + "schema": { + "name": "GetAssignedServerCertificates", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAssignedServerCertificatesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAssignedServerCertificatesResponse", + "schema": { + "name": "GetAssignedServerCertificatesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The IDs of all certification paths that are assigned to the TLS server on the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "SetClientAuthenticationRequired", + "port_type": "TLSServer", + "description": "This operation activates or deactivates TLS client authentication for the TLS server on the device. The TLS server on the device shall require client authentication if and only if clientAuthenticationRequired is set to true. If TLS client authentication is requested to be enabled and no certification path validation policy is assigned to the TLS server, the device shall return an EnablingTLSClientAuthenticationFailed fault and shall not enable TLS client authentication. The device shall execute this command regardless of the TLS enabled/disabled state configured in the ONVIF Device Management Service.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetClientAuthenticationRequiredRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetClientAuthenticationRequired", + "schema": { + "name": "SetClientAuthenticationRequired", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "clientAuthenticationRequired", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetClientAuthenticationRequiredResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetClientAuthenticationRequiredResponse", + "schema": { + "name": "SetClientAuthenticationRequiredResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "GetClientAuthenticationRequired", + "port_type": "TLSServer", + "description": "This operation returns whether TLS client authentication is active.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetClientAuthenticationRequiredRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetClientAuthenticationRequired", + "schema": { + "name": "GetClientAuthenticationRequired", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetClientAuthenticationRequiredResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetClientAuthenticationRequiredResponse", + "schema": { + "name": "GetClientAuthenticationRequiredResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "clientAuthenticationRequired", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "SetCnMapsToUser", + "port_type": "TLSServer", + "description": "This operation enables or disables mapping of the Common Name present in the TLS client certificate to an existing user name in the device. The TLS server on the device shall perform mapping if parameter clientAuthenticationRequired is set to true.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetCnMapsToUserRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetCnMapsToUser", + "schema": { + "name": "SetCnMapsToUser", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "cnMapsToUser", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetCnMapsToUserResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetCnMapsToUserResponse", + "schema": { + "name": "SetCnMapsToUserResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "GetCnMapsToUser", + "port_type": "TLSServer", + "description": "This operation returns whether the Common Name Mapping to User is enabled.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCnMapsToUserRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCnMapsToUser", + "schema": { + "name": "GetCnMapsToUser", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCnMapsToUserResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetCnMapsToUserResponse", + "schema": { + "name": "GetCnMapsToUserResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "cnMapsToUser", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "AddCertPathValidationPolicyAssignment", + "port_type": "TLSServer", + "description": "This operation assigns a certification path validation policy to the TLS server on the device. The TLS server shall enforce the policy when authenticating TLS clients and consider a client authentic if and only if the algorithm returns valid. If no certification path validation policy is stored under the requested CertPathValidationPolicyID, the device shall produce a CertPathValidationPolicyID fault. A TLS server may use different certification path validation policies to authenticate clients. Therefore more than one certification path validation policy may be assigned to the TLS server. If the maximum number of certification path validation policies that may be assigned to the TLS server simultaneously is reached, the device shall produce a MaximumNumberOfTLSCertPathValidationPoliciesReached fault and shall not assign the requested certification path validation policy to the TLS server.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddCertPathValidationPolicyAssignmentRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddCertPathValidationPolicyAssignment", + "schema": { + "name": "AddCertPathValidationPolicyAssignment", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certification path validation policy to assign to the TLS server." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddCertPathValidationPolicyAssignmentResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddCertPathValidationPolicyAssignmentResponse", + "schema": { + "name": "AddCertPathValidationPolicyAssignmentResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "RemoveCertPathValidationPolicyAssignment", + "port_type": "TLSServer", + "description": "This operation removes a certification path validation policy assignment from the TLS server on the device. If the certification path validation policy identified by the requested CertPathValidationPolicyID is not associated to the TLS server, the device shall produce a CertPathValidationPolicy fault.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}RemoveCertPathValidationPolicyAssignmentRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}RemoveCertPathValidationPolicyAssignment", + "schema": { + "name": "RemoveCertPathValidationPolicyAssignment", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certification path validation policy to de-assign from the TLS server." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}RemoveCertPathValidationPolicyAssignmentResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}RemoveCertPathValidationPolicyAssignmentResponse", + "schema": { + "name": "RemoveCertPathValidationPolicyAssignmentResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "ReplaceCertPathValidationPolicyAssignment", + "port_type": "TLSServer", + "description": "This operation replaces a certification path validation policy assignment to the TLS server on the device with another certification path validation policy assignment. If the certification path validation policy identified by the requested OldCertPathValidationPolicyID is not associated to the TLS server, the device shall produce an OldCertPathValidationPolicyID fault and shall not associate the certification path validation policy identified by the NewCertPathValidationPolicyID to the TLS server. If no certification path validation policy exists under the requested NewCertPathValidationPolicyID in the device’s keystore, the device shall produce a NewCertPathValidationPolicyID fault and shall not remove the association of the old certification path validation policy to the TLS server.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}ReplaceCertPathValidationPolicyAssignmentRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}ReplaceCertPathValidationPolicyAssignment", + "schema": { + "name": "ReplaceCertPathValidationPolicyAssignment", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OldCertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certification path validation policy to be de-assigned from the TLS server." + }, + { + "name": "NewCertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certification path validation policy to assign to the TLS server." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}ReplaceCertPathValidationPolicyAssignmentResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}ReplaceCertPathValidationPolicyAssignmentResponse", + "schema": { + "name": "ReplaceCertPathValidationPolicyAssignmentResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "GetAssignedCertPathValidationPolicies", + "port_type": "TLSServer", + "description": "This operation returns the IDs of all certification path validation policies that are assigned to the TLS server on the device.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAssignedCertPathValidationPoliciesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAssignedCertPathValidationPolicies", + "schema": { + "name": "GetAssignedCertPathValidationPolicies", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAssignedCertPathValidationPoliciesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAssignedCertPathValidationPoliciesResponse", + "schema": { + "name": "GetAssignedCertPathValidationPoliciesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of IDs of the certification path validation policies that are assigned to the TLS server." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "TLSServerBinding" + }, + { + "name": "AddDot1XConfiguration", + "port_type": "Dot1X", + "description": "This operation adds an IEEE 802.1X configuration to the device. Configurations are uniquely identified using IEEE 802.1X configuration IDs. The device shall ignore Dot1XID in the request, if present, and shall generate a unique configuration ID for the added configuration. If the command was successful, the device shall return the ID of the configuration. If the device does not have capacity for the configuration, the device shall produce a MaximumNumberOfDot1XConfigurationsReached fault and shall not add the configuration. If Identity is used as an anonymous identity for the corresponding authentication method, the device shall ignore an eventually supplied passphrase ID in the same Dot1XStage. Otherwise, if the device cannot process a passphrase ID included in the configuration to be added, the device shall produce a PassphraseID fault and shall not add the configuration. If the device cannot process a certification path ID included in the configuration to be added, the device shall produce a CertificationPathID fault and shall not add the configuration. If no certification path validation policy is stored under the requested certification path validation policy ID, the device shall produce a CertPathValidationPolicyID fault. If no certification path validation policy configured, authorization server certificate validation behavior is undefined and the device may either apply a vendor specific default validation policy or skip validation at all. If the device cannot process an authentication method included in the configuration to be added (e.g., unrecognized method or missing configuration parameter), the device shall produce a Dot1XMethod fault and shall not add the configuration. A device signalling support for IEEE 802.1X configuration with the MaximumNumberOfDot1XConfigurations capability shall support this command.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddDot1XConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddDot1XConfiguration", + "schema": { + "name": "AddDot1XConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Dot1XConfiguration", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XConfiguration", + "type_name": "Dot1XConfiguration", + "definition": { + "kind": "complexType", + "name": "Dot1XConfiguration", + "fields": [ + { + "name": "Dot1XID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XID", + "type_name": "Dot1XID", + "definition": { + "kind": "simpleType", + "name": "Dot1XID", + "description": "Unique identifier for 802.1X configurations in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the IEEE 802.1X configuration." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the 802.1X configuration." + }, + { + "name": "Outer", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XStage", + "type_name": "Dot1XStage", + "definition": { + "kind": "complexType", + "name": "Dot1XStage", + "description": "The configuration parameters required for a particular authentication method.", + "fields": [ + { + "name": "Identity", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The identity used in this authentication method, if required." + }, + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the certification path used in this authentication method, if required." + }, + { + "name": "PassphraseID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}PassphraseID", + "type_name": "PassphraseID", + "definition": { + "kind": "simpleType", + "name": "PassphraseID", + "description": "Unique identifier for passphrases in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The identifier for the password used in this authentication method, if required. If Identity is used as an anonymous identity for this authentication method, PassphraseID is ignored." + }, + { + "name": "Inner", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XStage", + "type_name": "Dot1XStage", + "recursive": true, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the next stage of authentication, if required." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XStageExtension", + "type_name": "Dot1XStageExtension", + "definition": { + "kind": "complexType", + "name": "Dot1XStageExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Method", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The authentication method for this stage (e.g., \"EAP-PEAP\")." + }, + { + "use": "optional", + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "description": "The unique identifier of the certification path validation policy to be used for validating the authorization server certificate.\n\t\t\t\t\t\t\tIf not configured, authorization server certificate validation behavior is undefined and the device may either apply a vendor specific default validation policy or skip validation at all." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The outer level authentication method used in this 802.1X configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The desired 802.1X configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddDot1XConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddDot1XConfigurationResponse", + "schema": { + "name": "AddDot1XConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Dot1XID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XID", + "type_name": "Dot1XID", + "definition": { + "kind": "simpleType", + "name": "Dot1XID", + "description": "Unique identifier for 802.1X configurations in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the created 802.1X configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Dot1XBinding" + }, + { + "name": "GetAllDot1XConfigurations", + "port_type": "Dot1X", + "description": "This operation returns details of all IEEE 802.1X configurations that are on the device. This operation may be used, e.g., if a client lost track of which IEEE 802.1X configurations are present on the device. If no IEEE 802.1X configurations exist on the device, an empty list is returned. A device signalling support for IEEE 802.1X configuration with the MaximumNumberOfDot1XConfigurations capability shall support this command.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllDot1XConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllDot1XConfigurations", + "schema": { + "name": "GetAllDot1XConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllDot1XConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAllDot1XConfigurationsResponse", + "schema": { + "name": "GetAllDot1XConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XConfiguration", + "type_name": "Dot1XConfiguration", + "definition": { + "kind": "complexType", + "name": "Dot1XConfiguration", + "fields": [ + { + "name": "Dot1XID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XID", + "type_name": "Dot1XID", + "definition": { + "kind": "simpleType", + "name": "Dot1XID", + "description": "Unique identifier for 802.1X configurations in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the IEEE 802.1X configuration." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the 802.1X configuration." + }, + { + "name": "Outer", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XStage", + "type_name": "Dot1XStage", + "definition": { + "kind": "complexType", + "name": "Dot1XStage", + "description": "The configuration parameters required for a particular authentication method.", + "fields": [ + { + "name": "Identity", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The identity used in this authentication method, if required." + }, + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the certification path used in this authentication method, if required." + }, + { + "name": "PassphraseID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}PassphraseID", + "type_name": "PassphraseID", + "definition": { + "kind": "simpleType", + "name": "PassphraseID", + "description": "Unique identifier for passphrases in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The identifier for the password used in this authentication method, if required. If Identity is used as an anonymous identity for this authentication method, PassphraseID is ignored." + }, + { + "name": "Inner", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XStage", + "type_name": "Dot1XStage", + "recursive": true, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the next stage of authentication, if required." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XStageExtension", + "type_name": "Dot1XStageExtension", + "definition": { + "kind": "complexType", + "name": "Dot1XStageExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Method", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The authentication method for this stage (e.g., \"EAP-PEAP\")." + }, + { + "use": "optional", + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "description": "The unique identifier of the certification path validation policy to be used for validating the authorization server certificate.\n\t\t\t\t\t\t\tIf not configured, authorization server certificate validation behavior is undefined and the device may either apply a vendor specific default validation policy or skip validation at all." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The outer level authentication method used in this 802.1X configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The list of unique identifiers of 802.1X configurations on the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Dot1XBinding" + }, + { + "name": "GetDot1XConfiguration", + "port_type": "Dot1X", + "description": "This operation returns details of a specific IEEE 802.1X configuration on the device. If the device cannot process the provided IEEE 802.1X configuration ID, the device shall produce a Dot1XConfigurationID fault. A device signalling support for IEEE 802.1X configuration with the MaximumNumberOfDot1XConfigurations capability shall support this command.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetDot1XConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetDot1XConfiguration", + "schema": { + "name": "GetDot1XConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Dot1XID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XID", + "type_name": "Dot1XID", + "definition": { + "kind": "simpleType", + "name": "Dot1XID", + "description": "Unique identifier for 802.1X configurations in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the desired 802.1X configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetDot1XConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetDot1XConfigurationResponse", + "schema": { + "name": "GetDot1XConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Dot1XConfiguration", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XConfiguration", + "type_name": "Dot1XConfiguration", + "definition": { + "kind": "complexType", + "name": "Dot1XConfiguration", + "fields": [ + { + "name": "Dot1XID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XID", + "type_name": "Dot1XID", + "definition": { + "kind": "simpleType", + "name": "Dot1XID", + "description": "Unique identifier for 802.1X configurations in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the IEEE 802.1X configuration." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The client-defined alias of the 802.1X configuration." + }, + { + "name": "Outer", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XStage", + "type_name": "Dot1XStage", + "definition": { + "kind": "complexType", + "name": "Dot1XStage", + "description": "The configuration parameters required for a particular authentication method.", + "fields": [ + { + "name": "Identity", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The identity used in this authentication method, if required." + }, + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the certification path used in this authentication method, if required." + }, + { + "name": "PassphraseID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}PassphraseID", + "type_name": "PassphraseID", + "definition": { + "kind": "simpleType", + "name": "PassphraseID", + "description": "Unique identifier for passphrases in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The identifier for the password used in this authentication method, if required. If Identity is used as an anonymous identity for this authentication method, PassphraseID is ignored." + }, + { + "name": "Inner", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XStage", + "type_name": "Dot1XStage", + "recursive": true, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the next stage of authentication, if required." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XStageExtension", + "type_name": "Dot1XStageExtension", + "definition": { + "kind": "complexType", + "name": "Dot1XStageExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Method", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The authentication method for this stage (e.g., \"EAP-PEAP\")." + }, + { + "use": "optional", + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "description": "The unique identifier of the certification path validation policy to be used for validating the authorization server certificate.\n\t\t\t\t\t\t\tIf not configured, authorization server certificate validation behavior is undefined and the device may either apply a vendor specific default validation policy or skip validation at all." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The outer level authentication method used in this 802.1X configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The 802.1X configuration, without password information." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Dot1XBinding" + }, + { + "name": "DeleteDot1XConfiguration", + "port_type": "Dot1X", + "description": "This operation deletes an IEEE 802.1X configuration from the device. If the device cannot process the provided IEEE 802.1X configuration ID, the device shall produce a Dot1XConfigurationID fault. If a reference exists for the specified IEEE 802.1X configuration, the device shall produce a ReferenceExists fault and shall not delete the configuration. After an IEEE 802.1X configuration has been successfully deleted, the device may assign its former ID to a new configuration. A device signalling support for IEEE 802.1X configuration with the MaximumNumberOfDot1XConfigurations capability shall support this command.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteDot1XConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteDot1XConfiguration", + "schema": { + "name": "DeleteDot1XConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Dot1XID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XID", + "type_name": "Dot1XID", + "definition": { + "kind": "simpleType", + "name": "Dot1XID", + "description": "Unique identifier for 802.1X configurations in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the 802.1X configuration to be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteDot1XConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteDot1XConfigurationResponse", + "schema": { + "name": "DeleteDot1XConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Dot1XBinding" + }, + { + "name": "SetNetworkInterfaceDot1XConfiguration", + "port_type": "Dot1X", + "description": "This operation binds an IEEE 802.1X configuration to a network interface on the device. This operation shall either create a new binding or replace an existing binding. On failure when an existing binding already exists, the existing binding shall remain. The Device Management SetNetworkInterface operation provides a method of binding an IEEE 802.1X configuration to an IEEE 802.11 (wireless) interface, and that operation may still be used. But there is no ability for SetNetworkInterface to bind an IEEE 802.1X configuration to a hardwired interface. This operation is provided to bind an IEEE 802.1X configuration to either type of interface. If SetNetworkInterfaceDot1XConfiguration is used to bind an IEEE 802.1X configuration to an IEEE 802.11 (wireless) interface, then the DeviceManagement GetNetworkInterfaces operation shall return the IEEE 802.1X configuration ID along with the rest of that interface's configuration information. If the device cannot process the provided network interface token, the device shall produce an InvalidNetworkInterface fault. If the device cannot process the provided IEEE 802.1X configuration ID, the device shall produce a Dot1XConfigurationID fault. A device signalling support for IEEE 802.1X configuration with the MaximumNumberOfDot1XConfigurations capability shall support this command.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetNetworkInterfaceDot1XConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetNetworkInterfaceDot1XConfiguration", + "schema": { + "name": "SetNetworkInterfaceDot1XConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "token", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the Network Interface on which the 802.1X configuration is to be set. (NOTE: the network interface token is defined in devicemgmt.wsdl as tt:ReferenceToken, which is a derived type of xs:string. To avoid importing all of common.xsd for this single type, the base type is used here.)" + }, + { + "name": "Dot1XID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XID", + "type_name": "Dot1XID", + "definition": { + "kind": "simpleType", + "name": "Dot1XID", + "description": "Unique identifier for 802.1X configurations in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the 802.1X configuration to be set." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetNetworkInterfaceDot1XConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetNetworkInterfaceDot1XConfigurationResponse", + "schema": { + "name": "SetNetworkInterfaceDot1XConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RebootNeeded", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not a reboot is required after configuration updates." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Dot1XBinding" + }, + { + "name": "GetNetworkInterfaceDot1XConfiguration", + "port_type": "Dot1X", + "description": "This operation returns the IEEE 802.1X ID and configuration associated with a network interface on the device. If there is no IEEE 802.1X configuration associated with the specified network interface, then the response shall be empty. If the Device Management SetNetworkInterface operation was used to bind an IEEE 802.1X configuration to an IEEE 802.11 (wireless) interface, then this operation shall return the IEEE 802.1X configuration information as if the SetNetworkInterfaceDot1XConfiguration operation had been used. If the device cannot process the provided network interface token, the device shall produce an InvalidNetworkInterface fault. A device signalling support for IEEE 802.1X configuration with the MaximumNumberOfDot1XConfigurations capability shall support this command.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetNetworkInterfaceDot1XConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetNetworkInterfaceDot1XConfiguration", + "schema": { + "name": "GetNetworkInterfaceDot1XConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "token", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the Network Interface for which the 802.1X configuration is to be retrieved. (NOTE: the network interface token is defined in devicemgmt.wsdl as tt:ReferenceToken, which is a derived type of xs:string. To avoid importing all of common.xsd for this single type, the base type is used here.)" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetNetworkInterfaceDot1XConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetNetworkInterfaceDot1XConfigurationResponse", + "schema": { + "name": "GetNetworkInterfaceDot1XConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Dot1XID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}Dot1XID", + "type_name": "Dot1XID", + "definition": { + "kind": "simpleType", + "name": "Dot1XID", + "description": "Unique identifier for 802.1X configurations in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of 802.1X configuration assigned to the Network Interface." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Dot1XBinding" + }, + { + "name": "DeleteNetworkInterfaceDot1XConfiguration", + "port_type": "Dot1X", + "description": "This operation unbinds the IEEE 802.1X configuration associated with a network interface on the device. If there is no IEEE 802.1X configuration associated with the specified network interface, then the operation does nothing. The Device Management SetNetworkInterface operation provides a method of unbinding an IEEE 802.1X configuration from an IEEE 802.11 (wireless) interface by omitting the configuration ID, and that operation may still be used. But there is no ability for SetNetworkInterface to unbind an IEEE 802.1X configuration from a hardwired interface. This operation is provided to unbind an IEEE 802.1X configuration from either type of interface. If the Device Management SetNetworkInterface operation was used to bind an IEEE 802.1X configuration to an IEEE 802.11 (wireless) interface, then this operation shall unbind the IEEE 802.1X configuration information as if the SetNetworkInterfaceDot1XConfiguration operation had been used. If the device cannot process the provided network interface token, the device shall produce an InvalidNetworkInterface fault. A device signalling support for IEEE 802.1X configuration with the MaximumNumberOfDot1XConfigurations capability shall support this command.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteNetworkInterfaceDot1XConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteNetworkInterfaceDot1XConfiguration", + "schema": { + "name": "DeleteNetworkInterfaceDot1XConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "token", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the Network Interface for which the 802.1X configuration is to be deleted. (NOTE: the network interface token is defined in devicemgmt.wsdl as tt:ReferenceToken, which is a derived type of xs:string. To avoid importing all of common.xsd for this single type, the base type is used here.)" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteNetworkInterfaceDot1XConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteNetworkInterfaceDot1XConfigurationResponse", + "schema": { + "name": "DeleteNetworkInterfaceDot1XConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RebootNeeded", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not a reboot is required after configuration updates." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Dot1XBinding" + }, + { + "name": "AddMediaSigningCertificateAssignment", + "port_type": "MediaSigning", + "description": "This operation assigns certification path (certificate chain) to use for media signing, replacing the one that is provisioned during factory production. The leaf certificate in the chain and its associated private key shall be used for signing media as described in the [Media Signing Specification]. This key and certificate is referred to as user provisioned key and certificate in that specification. If this operation is called when there is already a user provisioned certification path configured, the existing certification path shall be replaced with the new certification path. A device shall support this command if the UserMediaSigningKeySupported capability is true.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddMediaSigningCertificateAssignmentRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddMediaSigningCertificateAssignment", + "schema": { + "name": "AddMediaSigningCertificateAssignment", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddMediaSigningCertificateAssignmentResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AddMediaSigningCertificateAssignmentResponse", + "schema": { + "name": "AddMediaSigningCertificateAssignmentResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaSigningBinding" + }, + { + "name": "RemoveMediaSigningCertificateAssignment", + "port_type": "MediaSigning", + "description": "This operation removes a certificate assignment (including certification path) on the device that has been added by AddMediaSigningCertificateAssignment. The factory provisioned certification path cannot be removed. If media signing on the device is enabled, the device shall produce a ReferenceExists fault and shall not remove the certificate assignment. A device shall support this command if the UserMediaSigningKeySupported capability is true.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}RemoveMediaSigningCertificateAssignmentRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}RemoveMediaSigningCertificateAssignment", + "schema": { + "name": "RemoveMediaSigningCertificateAssignment", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}RemoveMediaSigningCertificateAssignmentResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}RemoveMediaSigningCertificateAssignmentResponse", + "schema": { + "name": "RemoveMediaSigningCertificateAssignmentResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaSigningBinding" + }, + { + "name": "GetAssignedMediaSigningCertificates", + "port_type": "MediaSigning", + "description": "This operation returns the IDs of the certification paths that are assigned for media signing on the device. This operation will always return the factory provisioned certification path and can additionally return a certification path that has been added by AddMediaSigningCertificateAssignment. A device shall support this command if the MediaSigningSupported capability is true.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAssignedMediaSigningCertificatesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAssignedMediaSigningCertificates", + "schema": { + "name": "GetAssignedMediaSigningCertificates", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAssignedMediaSigningCertificatesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAssignedMediaSigningCertificatesResponse", + "schema": { + "name": "GetAssignedMediaSigningCertificatesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificationPathID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificationPathID", + "type_name": "CertificationPathID", + "definition": { + "kind": "simpleType", + "name": "CertificationPathID", + "description": "Unique identifier for certification paths in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false, + "description": "The IDs of all certification paths that are assigned for media signing. Response list shall be ordered with factory-provisioned ID first, followed by user-provisioned ID.\n\t\t\t\t\t\t\t\tAs response structure includes just CertificationPathID, the client may retrieve the assigned media signing certificates by invoking GetCertificationPath with the CertificationPathID, followed by GetCertificates" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaSigningBinding" + }, + { + "name": "GetAuthorizationServerConfigurations", + "port_type": "AuthorizationServer", + "description": "This operation lists all existing authorization server configurations for the device.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAuthorizationServerConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAuthorizationServerConfigurations", + "schema": { + "name": "GetAuthorizationServerConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAuthorizationServerConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}GetAuthorizationServerConfigurationsResponse", + "schema": { + "name": "GetAuthorizationServerConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AuthorizationServerConfiguration", + "type_name": "AuthorizationServerConfiguration", + "definition": { + "kind": "complexType", + "name": "AuthorizationServerConfiguration", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Data", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AuthorizationServerConfigurationData", + "type_name": "AuthorizationServerConfigurationData", + "definition": { + "kind": "complexType", + "name": "AuthorizationServerConfigurationData", + "fields": [ + { + "name": "ServerUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Authorization server metadata endpoint conforming to RFC8414, such as \"https://your.domain/.well-known/openid-configuration\"" + }, + { + "name": "ClientID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Client identifier issued by the authorization server" + }, + { + "name": "ClientSecret", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Client secret used to authenticate with the authorization server" + }, + { + "name": "Scope", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The requested access scope(s)" + }, + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Key identifier for the private_key_jwt authentication method" + }, + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Certificate identifier for the self_signed_tls_client_auth authentication method" + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the certification path validation policy to be used for validating the server certificate." + } + ], + "attributes": [ + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The type of configuration, tas:AuthorizationServerConfigurationType lists the acceptable values" + }, + { + "use": "optional", + "name": "ClientAuth", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "How to authenticate with the server, tas:ClientAuthenticationMethod lists the acceptable values" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthorizationServerBinding" + }, + { + "name": "CreateAuthorizationServerConfiguration", + "port_type": "AuthorizationServer", + "description": "This operation creates a new authorization server configuration. The configuration data shall be created in the device and shall be persistent (remain after reboot).", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateAuthorizationServerConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateAuthorizationServerConfiguration", + "schema": { + "name": "CreateAuthorizationServerConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AuthorizationServerConfigurationData", + "type_name": "AuthorizationServerConfigurationData", + "definition": { + "kind": "complexType", + "name": "AuthorizationServerConfigurationData", + "fields": [ + { + "name": "ServerUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Authorization server metadata endpoint conforming to RFC8414, such as \"https://your.domain/.well-known/openid-configuration\"" + }, + { + "name": "ClientID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Client identifier issued by the authorization server" + }, + { + "name": "ClientSecret", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Client secret used to authenticate with the authorization server" + }, + { + "name": "Scope", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The requested access scope(s)" + }, + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Key identifier for the private_key_jwt authentication method" + }, + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Certificate identifier for the self_signed_tls_client_auth authentication method" + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the certification path validation policy to be used for validating the server certificate." + } + ], + "attributes": [ + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The type of configuration, tas:AuthorizationServerConfigurationType lists the acceptable values" + }, + { + "use": "optional", + "name": "ClientAuth", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "How to authenticate with the server, tas:ClientAuthenticationMethod lists the acceptable values" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateAuthorizationServerConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CreateAuthorizationServerConfigurationResponse", + "schema": { + "name": "CreateAuthorizationServerConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthorizationServerBinding" + }, + { + "name": "SetAuthorizationServerConfiguration", + "port_type": "AuthorizationServer", + "description": "This operation modifies an existing authorization server configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetAuthorizationServerConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetAuthorizationServerConfiguration", + "schema": { + "name": "SetAuthorizationServerConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AuthorizationServerConfiguration", + "type_name": "AuthorizationServerConfiguration", + "definition": { + "kind": "complexType", + "name": "AuthorizationServerConfiguration", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Data", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}AuthorizationServerConfigurationData", + "type_name": "AuthorizationServerConfigurationData", + "definition": { + "kind": "complexType", + "name": "AuthorizationServerConfigurationData", + "fields": [ + { + "name": "ServerUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Authorization server metadata endpoint conforming to RFC8414, such as \"https://your.domain/.well-known/openid-configuration\"" + }, + { + "name": "ClientID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Client identifier issued by the authorization server" + }, + { + "name": "ClientSecret", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Client secret used to authenticate with the authorization server" + }, + { + "name": "Scope", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The requested access scope(s)" + }, + { + "name": "KeyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}KeyID", + "type_name": "KeyID", + "definition": { + "kind": "simpleType", + "name": "KeyID", + "description": "Unique identifier for keys in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Key identifier for the private_key_jwt authentication method" + }, + { + "name": "CertificateID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertificateID", + "type_name": "CertificateID", + "definition": { + "kind": "simpleType", + "name": "CertificateID", + "description": "Unique identifier for certificates in the keystore.", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Certificate identifier for the self_signed_tls_client_auth authentication method" + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}CertPathValidationPolicyID", + "type_name": "CertPathValidationPolicyID", + "definition": { + "kind": "simpleType", + "name": "CertPathValidationPolicyID", + "base": "{http://www.w3.org/2001/XMLSchema}NCName", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the certification path validation policy to be used for validating the server certificate." + } + ], + "attributes": [ + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The type of configuration, tas:AuthorizationServerConfigurationType lists the acceptable values" + }, + { + "use": "optional", + "name": "ClientAuth", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "How to authenticate with the server, tas:ClientAuthenticationMethod lists the acceptable values" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetAuthorizationServerConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}SetAuthorizationServerConfigurationResponse", + "schema": { + "name": "SetAuthorizationServerConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthorizationServerBinding" + }, + { + "name": "DeleteAuthorizationServerConfiguration", + "port_type": "AuthorizationServer", + "description": "This operation deletes the given authorization server configuration and configuration change shall always be persistent.", + "input": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteAuthorizationServerConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteAuthorizationServerConfiguration", + "schema": { + "name": "DeleteAuthorizationServerConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteAuthorizationServerConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/advancedsecurity/wsdl}DeleteAuthorizationServerConfigurationResponse", + "schema": { + "name": "DeleteAuthorizationServerConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthorizationServerBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/analyticsdevice.json b/docs/generated/wsdl/ver10/analyticsdevice.json new file mode 100644 index 00000000..c967bcc4 --- /dev/null +++ b/docs/generated/wsdl/ver10/analyticsdevice.json @@ -0,0 +1,9561 @@ +{ + "source": "ver10/analyticsdevice.wsdl", + "target_namespace": "http://www.onvif.org/ver10/analyticsdevice/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "AnalyticsDevicePort", + "description": "Returns the capabilities of the analytics device service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the analytics device service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "DeleteAnalyticsEngineControl", + "port_type": "AnalyticsDevicePort", + "description": "DeleteAnalyticsEngineControl shall delete a control object .", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}DeleteAnalyticsEngineControlRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}DeleteAnalyticsEngineControl", + "schema": { + "name": "DeleteAnalyticsEngineControl", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Analytics Engine Control configuration to be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}DeleteAnalyticsEngineControlResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}DeleteAnalyticsEngineControlResponse", + "schema": { + "name": "DeleteAnalyticsEngineControlResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "CreateAnalyticsEngineControl", + "port_type": "AnalyticsDevicePort", + "description": "CreateAnalyticsEngineControl shall create a new control object.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}CreateAnalyticsEngineControlRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}CreateAnalyticsEngineControl", + "schema": { + "name": "CreateAnalyticsEngineControl", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineControl", + "type_name": "AnalyticsEngineControl", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineControl", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "EngineToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the analytics engine (AnalyticsEngine) being controlled." + }, + { + "name": "EngineConfigToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the analytics engine configuration (VideoAnalyticsConfiguration) in effect." + }, + { + "name": "InputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the input (AnalyticsEngineInput) configuration applied." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the receiver providing media input data. The order of ReceiverToken shall exactly match the order of InputToken." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Subscription", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ModeOfOperation", + "type_name": "ModeOfOperation", + "definition": { + "kind": "simpleType", + "name": "ModeOfOperation", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Idle" + }, + { + "value": "Active" + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Settings of the Analytics Engine Control configuration to be created. Mode shall be set to \"idle\"." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}CreateAnalyticsEngineControlResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}CreateAnalyticsEngineControlResponse", + "schema": { + "name": "CreateAnalyticsEngineControlResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineInput", + "type_name": "AnalyticsEngineInput", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineInput", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceIdentification", + "type": "{http://www.onvif.org/ver10/schema}SourceIdentification", + "type_name": "SourceIdentification", + "definition": { + "kind": "complexType", + "name": "SourceIdentification", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SourceIdentificationExtension", + "type_name": "SourceIdentificationExtension", + "definition": { + "kind": "complexType", + "name": "SourceIdentificationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "VideoInput", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfiguration", + "type_name": "VideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoding", + "type_name": "VideoEncoding", + "definition": { + "kind": "simpleType", + "name": "VideoEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "JPEG" + }, + { + "value": "MPEG4" + }, + { + "value": "H264" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Used video codec, either Jpeg, H.264 or Mpeg4" + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl", + "type_name": "VideoRateControl", + "definition": { + "kind": "complexType", + "name": "VideoRateControl", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor." + }, + { + "name": "EncodingInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)" + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum output bitrate in kbps." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Configuration", + "type_name": "Mpeg4Configuration", + "definition": { + "kind": "complexType", + "name": "Mpeg4Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "Mpeg4Profile", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Mpeg4 related parameters." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Configuration", + "type_name": "H264Configuration", + "definition": { + "kind": "complexType", + "name": "H264Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "H264Profile", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the H.264 profile, either baseline, main, extended or high" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure H.264 related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related video stream" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MetadataInput", + "type": "{http://www.onvif.org/ver10/schema}MetadataInput", + "type_name": "MetadataInput", + "definition": { + "kind": "complexType", + "name": "MetadataInput", + "fields": [ + { + "name": "MetadataConfig", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataInputExtension", + "type_name": "MetadataInputExtension", + "definition": { + "kind": "complexType", + "name": "MetadataInputExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Configuration containing token generated." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "SetAnalyticsEngineControl", + "port_type": "AnalyticsDevicePort", + "description": "This command modifies the AnalyticsEngineControl configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}SetAnalyticsEngineControlRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}SetAnalyticsEngineControl", + "schema": { + "name": "SetAnalyticsEngineControl", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineControl", + "type_name": "AnalyticsEngineControl", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineControl", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "EngineToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the analytics engine (AnalyticsEngine) being controlled." + }, + { + "name": "EngineConfigToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the analytics engine configuration (VideoAnalyticsConfiguration) in effect." + }, + { + "name": "InputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the input (AnalyticsEngineInput) configuration applied." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the receiver providing media input data. The order of ReceiverToken shall exactly match the order of InputToken." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Subscription", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ModeOfOperation", + "type_name": "ModeOfOperation", + "definition": { + "kind": "simpleType", + "name": "ModeOfOperation", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Idle" + }, + { + "value": "Active" + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified Analytics Engine Control configuration." + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}SetAnalyticsEngineControlResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}SetAnalyticsEngineControlResponse", + "schema": { + "name": "SetAnalyticsEngineControlResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "GetAnalyticsEngineControl", + "port_type": "AnalyticsDevicePort", + "description": "The GetAnalyticsEngineControl command fetches the analytics engine control if the analytics engine control token is known.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineControlRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineControl", + "schema": { + "name": "GetAnalyticsEngineControl", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested AnalyticsEngineControl configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineControlResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineControlResponse", + "schema": { + "name": "GetAnalyticsEngineControlResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineControl", + "type_name": "AnalyticsEngineControl", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineControl", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "EngineToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the analytics engine (AnalyticsEngine) being controlled." + }, + { + "name": "EngineConfigToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the analytics engine configuration (VideoAnalyticsConfiguration) in effect." + }, + { + "name": "InputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the input (AnalyticsEngineInput) configuration applied." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the receiver providing media input data. The order of ReceiverToken shall exactly match the order of InputToken." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Subscription", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ModeOfOperation", + "type_name": "ModeOfOperation", + "definition": { + "kind": "simpleType", + "name": "ModeOfOperation", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Idle" + }, + { + "value": "Active" + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configuration of the AnalyticsEngineControl." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "GetAnalyticsEngineControls", + "port_type": "AnalyticsDevicePort", + "description": "This operation lists all available analytics engine controls for the device.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineControlsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineControls", + "schema": { + "name": "GetAnalyticsEngineControls", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineControlsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineControlsResponse", + "schema": { + "name": "GetAnalyticsEngineControlsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AnalyticsEngineControls", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineControl", + "type_name": "AnalyticsEngineControl", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineControl", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "EngineToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the analytics engine (AnalyticsEngine) being controlled." + }, + { + "name": "EngineConfigToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the analytics engine configuration (VideoAnalyticsConfiguration) in effect." + }, + { + "name": "InputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the input (AnalyticsEngineInput) configuration applied." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the receiver providing media input data. The order of ReceiverToken shall exactly match the order of InputToken." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Subscription", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ModeOfOperation", + "type_name": "ModeOfOperation", + "definition": { + "kind": "simpleType", + "name": "ModeOfOperation", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Idle" + }, + { + "value": "Active" + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of available AnalyticsEngineControl configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "GetAnalyticsEngine", + "port_type": "AnalyticsDevicePort", + "description": "The GetAnalyticsEngine command fetches the analytics engine configuration if the token is known.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngine", + "schema": { + "name": "GetAnalyticsEngine", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested AnalyticsEngine configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineResponse", + "schema": { + "name": "GetAnalyticsEngineResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngine", + "type_name": "AnalyticsEngine", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngine", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsDeviceEngineConfiguration", + "type_name": "AnalyticsDeviceEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsDeviceEngineConfiguration", + "fields": [ + { + "name": "EngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}EngineConfiguration", + "type_name": "EngineConfiguration", + "definition": { + "kind": "complexType", + "name": "EngineConfiguration", + "fields": [ + { + "name": "VideoAnalyticsConfiguration", + "type": "{http://www.onvif.org/ver10/schema}VideoAnalyticsConfiguration", + "type_name": "VideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoAnalyticsConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfiguration", + "type_name": "RuleEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfiguration", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfigurationExtension", + "type_name": "RuleEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AnalyticsEngineInputInfo", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineInputInfo", + "type_name": "AnalyticsEngineInputInfo", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineInputInfo", + "fields": [ + { + "name": "InputInfo", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineInputInfoExtension", + "type_name": "AnalyticsEngineInputInfoExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineInputInfoExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsDeviceEngineConfigurationExtension", + "type_name": "AnalyticsDeviceEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsDeviceEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configuration of the AnalyticsEngine." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "GetAnalyticsEngines", + "port_type": "AnalyticsDevicePort", + "description": "This operation lists all available analytics engine configurations for the device.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEnginesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngines", + "schema": { + "name": "GetAnalyticsEngines", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEnginesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEnginesResponse", + "schema": { + "name": "GetAnalyticsEnginesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngine", + "type_name": "AnalyticsEngine", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngine", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsDeviceEngineConfiguration", + "type_name": "AnalyticsDeviceEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsDeviceEngineConfiguration", + "fields": [ + { + "name": "EngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}EngineConfiguration", + "type_name": "EngineConfiguration", + "definition": { + "kind": "complexType", + "name": "EngineConfiguration", + "fields": [ + { + "name": "VideoAnalyticsConfiguration", + "type": "{http://www.onvif.org/ver10/schema}VideoAnalyticsConfiguration", + "type_name": "VideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoAnalyticsConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfiguration", + "type_name": "RuleEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfiguration", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfigurationExtension", + "type_name": "RuleEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AnalyticsEngineInputInfo", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineInputInfo", + "type_name": "AnalyticsEngineInputInfo", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineInputInfo", + "fields": [ + { + "name": "InputInfo", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineInputInfoExtension", + "type_name": "AnalyticsEngineInputInfoExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineInputInfoExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsDeviceEngineConfigurationExtension", + "type_name": "AnalyticsDeviceEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsDeviceEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of available AnalyticsEngine configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "SetVideoAnalyticsConfiguration", + "port_type": "AnalyticsDevicePort", + "description": "A video analytics configuration is modified using this command.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}SetVideoAnalyticsConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}SetVideoAnalyticsConfiguration", + "schema": { + "name": "SetVideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}VideoAnalyticsConfiguration", + "type_name": "VideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoAnalyticsConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfiguration", + "type_name": "RuleEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfiguration", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfigurationExtension", + "type_name": "RuleEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified video analytics configuration. The configuration shall exist in the device." + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}SetVideoAnalyticsConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}SetVideoAnalyticsConfigurationResponse", + "schema": { + "name": "SetVideoAnalyticsConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "SetAnalyticsEngineInput", + "port_type": "AnalyticsDevicePort", + "description": "This command modifies the analytics engine input configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}SetAnalyticsEngineInputRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}SetAnalyticsEngineInput", + "schema": { + "name": "SetAnalyticsEngineInput", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineInput", + "type_name": "AnalyticsEngineInput", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineInput", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceIdentification", + "type": "{http://www.onvif.org/ver10/schema}SourceIdentification", + "type_name": "SourceIdentification", + "definition": { + "kind": "complexType", + "name": "SourceIdentification", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SourceIdentificationExtension", + "type_name": "SourceIdentificationExtension", + "definition": { + "kind": "complexType", + "name": "SourceIdentificationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "VideoInput", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfiguration", + "type_name": "VideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoding", + "type_name": "VideoEncoding", + "definition": { + "kind": "simpleType", + "name": "VideoEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "JPEG" + }, + { + "value": "MPEG4" + }, + { + "value": "H264" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Used video codec, either Jpeg, H.264 or Mpeg4" + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl", + "type_name": "VideoRateControl", + "definition": { + "kind": "complexType", + "name": "VideoRateControl", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor." + }, + { + "name": "EncodingInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)" + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum output bitrate in kbps." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Configuration", + "type_name": "Mpeg4Configuration", + "definition": { + "kind": "complexType", + "name": "Mpeg4Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "Mpeg4Profile", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Mpeg4 related parameters." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Configuration", + "type_name": "H264Configuration", + "definition": { + "kind": "complexType", + "name": "H264Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "H264Profile", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the H.264 profile, either baseline, main, extended or high" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure H.264 related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related video stream" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MetadataInput", + "type": "{http://www.onvif.org/ver10/schema}MetadataInput", + "type_name": "MetadataInput", + "definition": { + "kind": "complexType", + "name": "MetadataInput", + "fields": [ + { + "name": "MetadataConfig", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataInputExtension", + "type_name": "MetadataInputExtension", + "definition": { + "kind": "complexType", + "name": "MetadataInputExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified Analytics Engine Input configuration. The configuration shall exist in the device." + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}SetAnalyticsEngineInputResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}SetAnalyticsEngineInputResponse", + "schema": { + "name": "SetAnalyticsEngineInputResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "GetAnalyticsEngineInput", + "port_type": "AnalyticsDevicePort", + "description": "The GetAnalyticsEngineInput command fetches the input configuration if the analytics engine input configuration token is known.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineInputRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineInput", + "schema": { + "name": "GetAnalyticsEngineInput", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested AnalyticsEngineInput configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineInputResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineInputResponse", + "schema": { + "name": "GetAnalyticsEngineInputResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineInput", + "type_name": "AnalyticsEngineInput", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineInput", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceIdentification", + "type": "{http://www.onvif.org/ver10/schema}SourceIdentification", + "type_name": "SourceIdentification", + "definition": { + "kind": "complexType", + "name": "SourceIdentification", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SourceIdentificationExtension", + "type_name": "SourceIdentificationExtension", + "definition": { + "kind": "complexType", + "name": "SourceIdentificationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "VideoInput", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfiguration", + "type_name": "VideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoding", + "type_name": "VideoEncoding", + "definition": { + "kind": "simpleType", + "name": "VideoEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "JPEG" + }, + { + "value": "MPEG4" + }, + { + "value": "H264" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Used video codec, either Jpeg, H.264 or Mpeg4" + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl", + "type_name": "VideoRateControl", + "definition": { + "kind": "complexType", + "name": "VideoRateControl", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor." + }, + { + "name": "EncodingInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)" + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum output bitrate in kbps." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Configuration", + "type_name": "Mpeg4Configuration", + "definition": { + "kind": "complexType", + "name": "Mpeg4Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "Mpeg4Profile", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Mpeg4 related parameters." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Configuration", + "type_name": "H264Configuration", + "definition": { + "kind": "complexType", + "name": "H264Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "H264Profile", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the H.264 profile, either baseline, main, extended or high" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure H.264 related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related video stream" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MetadataInput", + "type": "{http://www.onvif.org/ver10/schema}MetadataInput", + "type_name": "MetadataInput", + "definition": { + "kind": "complexType", + "name": "MetadataInput", + "fields": [ + { + "name": "MetadataConfig", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataInputExtension", + "type_name": "MetadataInputExtension", + "definition": { + "kind": "complexType", + "name": "MetadataInputExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configuration of the AnalyticsEngineInput." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "GetAnalyticsEngineInputs", + "port_type": "AnalyticsDevicePort", + "description": "This operation lists all available analytics engine input configurations for the device.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineInputsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineInputs", + "schema": { + "name": "GetAnalyticsEngineInputs", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineInputsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsEngineInputsResponse", + "schema": { + "name": "GetAnalyticsEngineInputsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineInput", + "type_name": "AnalyticsEngineInput", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineInput", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceIdentification", + "type": "{http://www.onvif.org/ver10/schema}SourceIdentification", + "type_name": "SourceIdentification", + "definition": { + "kind": "complexType", + "name": "SourceIdentification", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SourceIdentificationExtension", + "type_name": "SourceIdentificationExtension", + "definition": { + "kind": "complexType", + "name": "SourceIdentificationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "VideoInput", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfiguration", + "type_name": "VideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoding", + "type_name": "VideoEncoding", + "definition": { + "kind": "simpleType", + "name": "VideoEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "JPEG" + }, + { + "value": "MPEG4" + }, + { + "value": "H264" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Used video codec, either Jpeg, H.264 or Mpeg4" + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl", + "type_name": "VideoRateControl", + "definition": { + "kind": "complexType", + "name": "VideoRateControl", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor." + }, + { + "name": "EncodingInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)" + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum output bitrate in kbps." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Configuration", + "type_name": "Mpeg4Configuration", + "definition": { + "kind": "complexType", + "name": "Mpeg4Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "Mpeg4Profile", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Mpeg4 related parameters." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Configuration", + "type_name": "H264Configuration", + "definition": { + "kind": "complexType", + "name": "H264Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "H264Profile", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the H.264 profile, either baseline, main, extended or high" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure H.264 related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related video stream" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MetadataInput", + "type": "{http://www.onvif.org/ver10/schema}MetadataInput", + "type_name": "MetadataInput", + "definition": { + "kind": "complexType", + "name": "MetadataInput", + "fields": [ + { + "name": "MetadataConfig", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataInputExtension", + "type_name": "MetadataInputExtension", + "definition": { + "kind": "complexType", + "name": "MetadataInputExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of available AnalyticsEngineInput configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "GetAnalyticsDeviceStreamUri", + "port_type": "AnalyticsDevicePort", + "description": "This operation requests a URI that can be used to initiate a live stream using RTSP as the control protocol if the token of the AnalyticsEngineControl is known.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsDeviceStreamUriRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsDeviceStreamUri", + "schema": { + "name": "GetAnalyticsDeviceStreamUri", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StreamSetup", + "type": "{http://www.onvif.org/ver10/schema}StreamSetup", + "type_name": "StreamSetup", + "definition": { + "kind": "complexType", + "name": "StreamSetup", + "fields": [ + { + "name": "Stream", + "type": "{http://www.onvif.org/ver10/schema}StreamType", + "type_name": "StreamType", + "definition": { + "kind": "simpleType", + "name": "StreamType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "RTP-Unicast" + }, + { + "value": "RTP-Multicast" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines if a multicast or unicast stream is requested." + }, + { + "name": "Transport", + "type": "{http://www.onvif.org/ver10/schema}Transport", + "type_name": "Transport", + "definition": { + "kind": "complexType", + "name": "Transport", + "fields": [ + { + "name": "Protocol", + "type": "{http://www.onvif.org/ver10/schema}TransportProtocol", + "type_name": "TransportProtocol", + "definition": { + "kind": "simpleType", + "name": "TransportProtocol", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "UDP" + }, + { + "value": "TCP", + "description": "This value is deprecated." + }, + { + "value": "RTSP" + }, + { + "value": "HTTP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP." + }, + { + "name": "Tunnel", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Deprecated: optional element to describe further tunnel options." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configuration of the URI requested." + }, + { + "name": "AnalyticsEngineControlToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the AnalyticsEngineControl whose URI is requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsDeviceStreamUriResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsDeviceStreamUriResponse", + "schema": { + "name": "GetAnalyticsDeviceStreamUriResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Streaming URI." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "GetVideoAnalyticsConfiguration", + "port_type": "AnalyticsDevicePort", + "description": "The GetVideoAnalyticsConfiguration command fetches the video analytics configuration if the video analytics configuration token is known.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetVideoAnalyticsConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetVideoAnalyticsConfiguration", + "schema": { + "name": "GetVideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the VideoAnalyticsConfiguration requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetVideoAnalyticsConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetVideoAnalyticsConfigurationResponse", + "schema": { + "name": "GetVideoAnalyticsConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}VideoAnalyticsConfiguration", + "type_name": "VideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoAnalyticsConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfiguration", + "type_name": "RuleEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfiguration", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfigurationExtension", + "type_name": "RuleEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Settings of the VideoAnalyticsConfiguration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "CreateAnalyticsEngineInputs", + "port_type": "AnalyticsDevicePort", + "description": "This command generates one or more analytics engine input configurations.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}CreateAnalyticsEngineInputsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}CreateAnalyticsEngineInputs", + "schema": { + "name": "CreateAnalyticsEngineInputs", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineInput", + "type_name": "AnalyticsEngineInput", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineInput", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceIdentification", + "type": "{http://www.onvif.org/ver10/schema}SourceIdentification", + "type_name": "SourceIdentification", + "definition": { + "kind": "complexType", + "name": "SourceIdentification", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SourceIdentificationExtension", + "type_name": "SourceIdentificationExtension", + "definition": { + "kind": "complexType", + "name": "SourceIdentificationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "VideoInput", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfiguration", + "type_name": "VideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoding", + "type_name": "VideoEncoding", + "definition": { + "kind": "simpleType", + "name": "VideoEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "JPEG" + }, + { + "value": "MPEG4" + }, + { + "value": "H264" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Used video codec, either Jpeg, H.264 or Mpeg4" + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl", + "type_name": "VideoRateControl", + "definition": { + "kind": "complexType", + "name": "VideoRateControl", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor." + }, + { + "name": "EncodingInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)" + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum output bitrate in kbps." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Configuration", + "type_name": "Mpeg4Configuration", + "definition": { + "kind": "complexType", + "name": "Mpeg4Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "Mpeg4Profile", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Mpeg4 related parameters." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Configuration", + "type_name": "H264Configuration", + "definition": { + "kind": "complexType", + "name": "H264Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "H264Profile", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the H.264 profile, either baseline, main, extended or high" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure H.264 related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related video stream" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MetadataInput", + "type": "{http://www.onvif.org/ver10/schema}MetadataInput", + "type_name": "MetadataInput", + "definition": { + "kind": "complexType", + "name": "MetadataInput", + "fields": [ + { + "name": "MetadataConfig", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataInputExtension", + "type_name": "MetadataInputExtension", + "definition": { + "kind": "complexType", + "name": "MetadataInputExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Settings of the configurations to be created." + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}CreateAnalyticsEngineInputsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}CreateAnalyticsEngineInputsResponse", + "schema": { + "name": "CreateAnalyticsEngineInputsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineInput", + "type_name": "AnalyticsEngineInput", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineInput", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceIdentification", + "type": "{http://www.onvif.org/ver10/schema}SourceIdentification", + "type_name": "SourceIdentification", + "definition": { + "kind": "complexType", + "name": "SourceIdentification", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SourceIdentificationExtension", + "type_name": "SourceIdentificationExtension", + "definition": { + "kind": "complexType", + "name": "SourceIdentificationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "VideoInput", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfiguration", + "type_name": "VideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoding", + "type_name": "VideoEncoding", + "definition": { + "kind": "simpleType", + "name": "VideoEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "JPEG" + }, + { + "value": "MPEG4" + }, + { + "value": "H264" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Used video codec, either Jpeg, H.264 or Mpeg4" + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl", + "type_name": "VideoRateControl", + "definition": { + "kind": "complexType", + "name": "VideoRateControl", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor." + }, + { + "name": "EncodingInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)" + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum output bitrate in kbps." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Configuration", + "type_name": "Mpeg4Configuration", + "definition": { + "kind": "complexType", + "name": "Mpeg4Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "Mpeg4Profile", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Mpeg4 related parameters." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Configuration", + "type_name": "H264Configuration", + "definition": { + "kind": "complexType", + "name": "H264Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "H264Profile", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the H.264 profile, either baseline, main, extended or high" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure H.264 related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related video stream" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MetadataInput", + "type": "{http://www.onvif.org/ver10/schema}MetadataInput", + "type_name": "MetadataInput", + "definition": { + "kind": "complexType", + "name": "MetadataInput", + "fields": [ + { + "name": "MetadataConfig", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataInputExtension", + "type_name": "MetadataInputExtension", + "definition": { + "kind": "complexType", + "name": "MetadataInputExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Configurations containing token generated." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "DeleteAnalyticsEngineInputs", + "port_type": "AnalyticsDevicePort", + "description": "This command deletes analytics engine input configurations if the tokens are known.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}DeleteAnalyticsEngineInputsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}DeleteAnalyticsEngineInputs", + "schema": { + "name": "DeleteAnalyticsEngineInputs", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "LIst of tokens of Analytics Engine Input configurations to be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}DeleteAnalyticsEngineInputsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}DeleteAnalyticsEngineInputsResponse", + "schema": { + "name": "DeleteAnalyticsEngineInputsResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + }, + { + "name": "GetAnalyticsState", + "port_type": "AnalyticsDevicePort", + "description": "GetAnalyticsState returns status information of the referenced AnalyticsEngineControl object.", + "input": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsStateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsState", + "schema": { + "name": "GetAnalyticsState", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AnalyticsEngineControlToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the AnalyticsEngineControl whose state information is requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsStateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/analyticsdevice/wsdl}GetAnalyticsStateResponse", + "schema": { + "name": "GetAnalyticsStateResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "State", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsStateInformation", + "type_name": "AnalyticsStateInformation", + "definition": { + "kind": "complexType", + "name": "AnalyticsStateInformation", + "fields": [ + { + "name": "AnalyticsEngineControlToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the control object whose status is requested." + }, + { + "name": "State", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsState", + "type_name": "AnalyticsState", + "definition": { + "kind": "complexType", + "name": "AnalyticsState", + "fields": [ + { + "name": "Error", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "State", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current status information." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsDeviceBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/appmgmt/wsdl/appmgmt.json b/docs/generated/wsdl/ver10/appmgmt/wsdl/appmgmt.json new file mode 100644 index 00000000..cc2cf6ef --- /dev/null +++ b/docs/generated/wsdl/ver10/appmgmt/wsdl/appmgmt.json @@ -0,0 +1,758 @@ +{ + "source": "ver10/appmgmt/wsdl/appmgmt.wsdl", + "target_namespace": "http://www.onvif.org/ver10/appmgmt/wsdl", + "operations": [ + { + "name": "Uninstall", + "port_type": "AppManagement", + "description": "Removes an app from a device. This method shall return immedeiately and not wait until the application is completely removed. On completion or failure the method shall generate an UninstallCompletion event.", + "input": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}UninstallRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}Uninstall", + "schema": { + "name": "Uninstall", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AppID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "App to be uninstalled. Possible failures during deinstallation will be delivered via an event." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}UninstallResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}UninstallResponse", + "schema": { + "name": "UninstallResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AppManagementBinding" + }, + { + "name": "GetInstalledApps", + "port_type": "AppManagement", + "description": "List installed apps on the device.", + "input": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetInstalledAppsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetInstalledApps", + "schema": { + "name": "GetInstalledApps", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetInstalledAppsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetInstalledAppsResponse", + "schema": { + "name": "GetInstalledAppsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "App", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AppID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of installed apps providing both user readable name and token." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AppManagementBinding" + }, + { + "name": "GetAppsInfo", + "port_type": "AppManagement", + "description": "The caller may provide an application ID to retrieve the information for a single application. If no application ID is provided the device shall report the information for all installed applications.", + "input": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetAppsInfoRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetAppsInfo", + "schema": { + "name": "GetAppsInfo", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AppID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ID to only retrieve information for a single application." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetAppsInfoResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetAppsInfoResponse", + "schema": { + "name": "GetAppsInfoResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Info", + "type": "{http://www.onvif.org/ver10/appmgmt/wsdl}AppInfo", + "type_name": "AppInfo", + "definition": { + "kind": "complexType", + "name": "AppInfo", + "fields": [ + { + "name": "AppID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique app identifier of the application instance." + }, + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable application name" + }, + { + "name": "Version", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Version of the installed application. The details of the format are outside of the scope of this specificaton." + }, + { + "name": "Licenses", + "type": "{http://www.onvif.org/ver10/appmgmt/wsdl}LicenseInfo", + "type_name": "LicenseInfo", + "definition": { + "kind": "complexType", + "name": "LicenseInfo", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Textual name of the license" + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start time of validity" + }, + { + "name": "ValidUntil", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "End time of validity" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Licenses associated with the application." + }, + { + "name": "Privileges", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of privileges granted to the application." + }, + { + "name": "InstallationDate", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Date and time when the application has been installed." + }, + { + "name": "LastUpdate", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Time of last update to this app, i.e. the time when this particular version was installed." + }, + { + "name": "State", + "type": "{http://www.onvif.org/ver10/appmgmt/wsdl}AppState", + "type_name": "AppState", + "definition": { + "kind": "simpleType", + "name": "AppState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Active" + }, + { + "value": "Inactive" + }, + { + "value": "Installing" + }, + { + "value": "Uninstalling" + }, + { + "value": "Removed" + }, + { + "value": "InstallationFailed" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "InstallationFailed state shall not be used here." + }, + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supplemental information why the application is in the current state. In error cases this field contains the error reason." + }, + { + "name": "Autostart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If set the application will start automatically after booting of the device." + }, + { + "name": "Website", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Link to supplementary information about the application or its vendor." + }, + { + "name": "OpenSource", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Link to a list of open source licenses used by the application." + }, + { + "name": "Configuration", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional Uri for backup and restore of the application configuration." + }, + { + "name": "InterfaceDescription", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional reference to the interface definition of the application." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AppManagementBinding" + }, + { + "name": "Activate", + "port_type": "AppManagement", + "description": "Starts an application.", + "input": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}ActivateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}Activate", + "schema": { + "name": "Activate", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AppID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "App identifier." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}ActivateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}ActivateResponse", + "schema": { + "name": "ActivateResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AppManagementBinding" + }, + { + "name": "Deactivate", + "port_type": "AppManagement", + "description": "Stops an application.", + "input": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}DeactivateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}Deactivate", + "schema": { + "name": "Deactivate", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AppID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "App identifier." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}DeactivateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}DeactivateResponse", + "schema": { + "name": "DeactivateResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AppManagementBinding" + }, + { + "name": "GetServiceCapabilities", + "port_type": "AppManagement", + "description": "Returns the capabilities of the app management service.", + "input": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/appmgmt/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "FormatsSupported", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported app container formats that can be uploaded via this service." + }, + { + "use": "optional", + "name": "Licensing", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Signals support for licensing of applications." + }, + { + "use": "optional", + "name": "UploadPath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Path part of the URI to which applications can be uploaded via http POST. \n Clients shall use protocol, hostname and port of the service address since the device may e.g. reside behind NAT translation firewall." + }, + { + "use": "optional", + "name": "EventTopicPrefix", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional Event Topic prefix used when delivering app events in eventservice." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities of the service." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AppManagementBinding" + }, + { + "name": "InstallLicense", + "port_type": "AppManagement", + "description": "Installs a license to the device. If the device requires PerApp licensing than the AppID parameter shall be provided.", + "input": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}InstallLicenseRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}InstallLicense", + "schema": { + "name": "InstallLicense", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AppID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Application the license shall be associated to." + }, + { + "name": "License", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Opaque machine readable license string." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}InstallLicenseResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}InstallLicenseResponse", + "schema": { + "name": "InstallLicenseResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AppManagementBinding" + }, + { + "name": "GetDeviceId", + "port_type": "AppManagement", + "description": "Get the unique device id to which the licenses are issued.", + "input": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetDeviceIdRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetDeviceId", + "schema": { + "name": "GetDeviceId", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetDeviceIdResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/appmgmt/wsdl}GetDeviceIdResponse", + "schema": { + "name": "GetDeviceIdResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DeviceId", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AppManagementBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/authenticationbehavior/wsdl/authenticationbehavior.json b/docs/generated/wsdl/ver10/authenticationbehavior/wsdl/authenticationbehavior.json new file mode 100644 index 00000000..ab6c8a76 --- /dev/null +++ b/docs/generated/wsdl/ver10/authenticationbehavior/wsdl/authenticationbehavior.json @@ -0,0 +1,3860 @@ +{ + "source": "ver10/authenticationbehavior/wsdl/authenticationbehavior.wsdl", + "target_namespace": "http://www.onvif.org/ver10/authenticationbehavior/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation returns the capabilities of the authentication behavior service.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}ServiceCapabilities", + "type_name": "ServiceCapabilities", + "definition": { + "kind": "complexType", + "name": "ServiceCapabilities", + "description": "The service capabilities reflect optional functionality of a service. The information is static\n\t\t\t\t\t\tand does not change during device operation. The following capabilities are available:", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "MaxLimit", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "The maximum number of entries returned by a single Get<Entity>List or Get<Entity>\n\t\t\t\t\t\t\trequest.\n\t\t\t\t\t\t\tThe device shall never return more than this number of entities in a single response." + }, + { + "use": "required", + "name": "MaxAuthenticationProfiles", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "Indicates the maximum number of authentication profiles the device supports. The device\n\t\t\t\t\t\t\tshall\n\t\t\t\t\t\t\tsupport at least one authentication profile." + }, + { + "use": "required", + "name": "MaxPoliciesPerAuthenticationProfile", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "Indicates the maximum number of authentication policies per authentication profile supported\n\t\t\t\t\t\t\tby the device." + }, + { + "use": "required", + "name": "MaxSecurityLevels", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "Indicates the maximum number of security levels the device supports. The device shall\n\t\t\t\t\t\t\tsupport at least one\n\t\t\t\t\t\t\tsecurity level." + }, + { + "use": "required", + "name": "MaxRecognitionGroupsPerSecurityLevel", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "Indicates the maximum number of recognition groups per security level supported by the\n\t\t\t\t\t\t\tdevice." + }, + { + "use": "required", + "name": "MaxRecognitionMethodsPerRecognitionGroup", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "Indicates the maximum number of recognition methods per recognition group supported by the\n\t\t\t\t\t\t\tdevice." + }, + { + "use": "optional", + "name": "ClientSuppliedTokenSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false", + "description": "Indicates that the client is allowed to supply the token when creating authentication\n\t\t\t\t\t\t\tprofiles and\n\t\t\t\t\t\t\tsecurity levels. To enable the use of the commands SetAuthenticationProfile and\n\t\t\t\t\t\t\tSetSecurityLevel, the\n\t\t\t\t\t\t\tvalue must be set to true." + }, + { + "use": "optional", + "name": "SupportedAuthenticationModes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "A list of supported authentication modes (including custom modes).\n\t\t\t\t\t\t\tThis field is optional, and when omitted, the client shall assume that the\n\t\t\t\t\t\t\tdevice supports \"pt:SingleCredential\" only." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capability response message contains the requested access rules\n\t\t\t\t\t\t\t\t\tservice capabilities using a hierarchical XML capability structure." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "GetAuthenticationProfileInfo", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation requests a list of AuthenticationProfileInfo items matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. The device shall not return a fault in this case.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfileInfoRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfileInfo", + "schema": { + "name": "GetAuthenticationProfileInfo", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of AuthenticationProfileInfo items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfileInfoResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfileInfoResponse", + "schema": { + "name": "GetAuthenticationProfileInfoResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AuthenticationProfileInfo", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfileInfo", + "type_name": "AuthenticationProfileInfo", + "definition": { + "kind": "complexType", + "name": "AuthenticationProfileInfo", + "description": "The AuthenticationProfileInfo structure contains information of a specific authentication\n\t\t\t\t\t\tprofile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of AuthenticationProfileInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "GetAuthenticationProfileInfoList", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation requests a list of all of AuthenticationProfileInfo items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer Access Control Service Specification for more details. The number of items returned shall not be greater than Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfileInfoListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfileInfoList", + "schema": { + "name": "GetAuthenticationProfileInfoList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is determined by the\n\t\t\t\t\t\t\t\t\tdevice." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfileInfoListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfileInfoListResponse", + "schema": { + "name": "GetAuthenticationProfileInfoListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "AuthenticationProfileInfo", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfileInfo", + "type_name": "AuthenticationProfileInfo", + "definition": { + "kind": "complexType", + "name": "AuthenticationProfileInfo", + "description": "The AuthenticationProfileInfo structure contains information of a specific authentication\n\t\t\t\t\t\tprofile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of AuthenticationProfileInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "GetAuthenticationProfiles", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation returns the specified AuthenticationProfile item matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching specified tokens. The device shall not return a fault in this case.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfilesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfiles", + "schema": { + "name": "GetAuthenticationProfiles", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of AuthenticationProfile items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfilesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfilesResponse", + "schema": { + "name": "GetAuthenticationProfilesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AuthenticationProfile", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfile", + "type_name": "AuthenticationProfile", + "definition": { + "kind": "complexType", + "name": "AuthenticationProfile", + "description": "The AuthenticationProfile structure shall include all properties of the\n\t\t\t\t\t\tAuthenticationProfileInfo structure\n\t\t\t\t\t\tand also a default security level, an authentication mode, and a list of AuthenticationProfile\n\t\t\t\t\t\tinstances.", + "base": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfileInfo", + "base_definition": { + "kind": "complexType", + "name": "AuthenticationProfileInfo", + "description": "The AuthenticationProfileInfo structure contains information of a specific authentication\n\t\t\t\t\t\tprofile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "DefaultSecurityLevelToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The default security level is used if none of the authentication policies\n\t\t\t\t\t\t\t\t\t\thas a schedule covering the time of access (or if no authentication policies\n\t\t\t\t\t\t\t\t\t\tare defined)." + }, + { + "name": "AuthenticationPolicy", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationPolicy", + "type_name": "AuthenticationPolicy", + "definition": { + "kind": "complexType", + "name": "AuthenticationPolicy", + "description": "The authentication policy is an association of a security level and a schedule. It defines when\n\t\t\t\t\t\ta certain security level is required to grant access to a credential holder. Each security \n\t\t\t\t\t\tlevel is given a unique priority. If authentication policies have overlapping schedules, \n\t\t\t\t\t\tthe security level with the highest priority is used.", + "fields": [ + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the schedule used by the authentication policy." + }, + { + "name": "SecurityLevelConstraint", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelConstraint", + "type_name": "SecurityLevelConstraint", + "definition": { + "kind": "complexType", + "name": "SecurityLevelConstraint", + "description": "This structure defines what security level should be active depending on the state of the\n\t\t\t\t\t\tschedule.", + "fields": [ + { + "name": "ActiveRegularSchedule", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Corresponds to the Active field in the ScheduleState structure in\n\t\t\t\t\t\t\t\t[ONVIF Schedule Service Specification]." + }, + { + "name": "ActiveSpecialDaySchedule", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Corresponds to the SpecialDay field in the ScheduleState structure in\n\t\t\t\t\t\t\t\t[ONVIF Schedule Service Specification].\n\t\t\t\t\t\t\t\tThis field will be ignored if the device do not support special days." + }, + { + "name": "AuthenticationMode", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines the mode of authentication. Authentication modes starting with the prefix\n\t\t\t\t\t\t\t\tpt: are reserved to define ONVIF-specific authentication modes. For custom defined\n\t\t\t\t\t\t\t\tauthentication modes, free text can be used.\n\t\t\t\t\t\t\t\tThe following authentication modes are defined by ONVIF:\n\t\t\t\t\t\t\t\tpt:SingleCredential - Normal mode where only one credential holder is required to be granted access.\n\t\t\t\t\t\t\t\tpt:DualCredential - Two credential holders are required to be granted access", + "default": "pt:SingleCredential" + }, + { + "name": "SecurityLevelToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the security level used by the authentication policy." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelConstraintExtension", + "type_name": "SecurityLevelConstraintExtension", + "definition": { + "kind": "complexType", + "name": "SecurityLevelConstraintExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of security level constraint structures defining the conditions\n\t\t\t\t\t\t\t\tfor what security level to use.\n\t\t\t\t\t\t\t\tMinimum one security level constraint must be specified." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationPolicyExtension", + "type_name": "AuthenticationPolicyExtension", + "definition": { + "kind": "complexType", + "name": "AuthenticationPolicyExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Each authentication policy associates a security level with a schedule (during\n\t\t\t\t\t\t\t\t\t\twhich the specified security level will be required at the access point)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfileExtension", + "type_name": "AuthenticationProfileExtension", + "definition": { + "kind": "complexType", + "name": "AuthenticationProfileExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of AuthenticationProfile items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "GetAuthenticationProfileList", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation requests a list of all of AuthenticationProfile items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer Access Control Service Specification for more details. The number of items returned shall not be greater the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfileListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfileList", + "schema": { + "name": "GetAuthenticationProfileList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is determined by the\n\t\t\t\t\t\t\t\t\tdevice." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfileListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetAuthenticationProfileListResponse", + "schema": { + "name": "GetAuthenticationProfileListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "AuthenticationProfile", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfile", + "type_name": "AuthenticationProfile", + "definition": { + "kind": "complexType", + "name": "AuthenticationProfile", + "description": "The AuthenticationProfile structure shall include all properties of the\n\t\t\t\t\t\tAuthenticationProfileInfo structure\n\t\t\t\t\t\tand also a default security level, an authentication mode, and a list of AuthenticationProfile\n\t\t\t\t\t\tinstances.", + "base": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfileInfo", + "base_definition": { + "kind": "complexType", + "name": "AuthenticationProfileInfo", + "description": "The AuthenticationProfileInfo structure contains information of a specific authentication\n\t\t\t\t\t\tprofile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "DefaultSecurityLevelToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The default security level is used if none of the authentication policies\n\t\t\t\t\t\t\t\t\t\thas a schedule covering the time of access (or if no authentication policies\n\t\t\t\t\t\t\t\t\t\tare defined)." + }, + { + "name": "AuthenticationPolicy", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationPolicy", + "type_name": "AuthenticationPolicy", + "definition": { + "kind": "complexType", + "name": "AuthenticationPolicy", + "description": "The authentication policy is an association of a security level and a schedule. It defines when\n\t\t\t\t\t\ta certain security level is required to grant access to a credential holder. Each security \n\t\t\t\t\t\tlevel is given a unique priority. If authentication policies have overlapping schedules, \n\t\t\t\t\t\tthe security level with the highest priority is used.", + "fields": [ + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the schedule used by the authentication policy." + }, + { + "name": "SecurityLevelConstraint", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelConstraint", + "type_name": "SecurityLevelConstraint", + "definition": { + "kind": "complexType", + "name": "SecurityLevelConstraint", + "description": "This structure defines what security level should be active depending on the state of the\n\t\t\t\t\t\tschedule.", + "fields": [ + { + "name": "ActiveRegularSchedule", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Corresponds to the Active field in the ScheduleState structure in\n\t\t\t\t\t\t\t\t[ONVIF Schedule Service Specification]." + }, + { + "name": "ActiveSpecialDaySchedule", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Corresponds to the SpecialDay field in the ScheduleState structure in\n\t\t\t\t\t\t\t\t[ONVIF Schedule Service Specification].\n\t\t\t\t\t\t\t\tThis field will be ignored if the device do not support special days." + }, + { + "name": "AuthenticationMode", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines the mode of authentication. Authentication modes starting with the prefix\n\t\t\t\t\t\t\t\tpt: are reserved to define ONVIF-specific authentication modes. For custom defined\n\t\t\t\t\t\t\t\tauthentication modes, free text can be used.\n\t\t\t\t\t\t\t\tThe following authentication modes are defined by ONVIF:\n\t\t\t\t\t\t\t\tpt:SingleCredential - Normal mode where only one credential holder is required to be granted access.\n\t\t\t\t\t\t\t\tpt:DualCredential - Two credential holders are required to be granted access", + "default": "pt:SingleCredential" + }, + { + "name": "SecurityLevelToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the security level used by the authentication policy." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelConstraintExtension", + "type_name": "SecurityLevelConstraintExtension", + "definition": { + "kind": "complexType", + "name": "SecurityLevelConstraintExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of security level constraint structures defining the conditions\n\t\t\t\t\t\t\t\tfor what security level to use.\n\t\t\t\t\t\t\t\tMinimum one security level constraint must be specified." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationPolicyExtension", + "type_name": "AuthenticationPolicyExtension", + "definition": { + "kind": "complexType", + "name": "AuthenticationPolicyExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Each authentication policy associates a security level with a schedule (during\n\t\t\t\t\t\t\t\t\t\twhich the specified security level will be required at the access point)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfileExtension", + "type_name": "AuthenticationProfileExtension", + "definition": { + "kind": "complexType", + "name": "AuthenticationProfileExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of AuthenticationProfile items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "CreateAuthenticationProfile", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation creates the specified authentication profile in the device. The token field of the AuthenticationProfile structure shall be empty and the device shall allocate a token for the authentication profile. The allocated token shall be returned in the response. If the client sends any value in the token field, the device shall return InvalidArgVal as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}CreateAuthenticationProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}CreateAuthenticationProfile", + "schema": { + "name": "CreateAuthenticationProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AuthenticationProfile", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfile", + "type_name": "AuthenticationProfile", + "definition": { + "kind": "complexType", + "name": "AuthenticationProfile", + "description": "The AuthenticationProfile structure shall include all properties of the\n\t\t\t\t\t\tAuthenticationProfileInfo structure\n\t\t\t\t\t\tand also a default security level, an authentication mode, and a list of AuthenticationProfile\n\t\t\t\t\t\tinstances.", + "base": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfileInfo", + "base_definition": { + "kind": "complexType", + "name": "AuthenticationProfileInfo", + "description": "The AuthenticationProfileInfo structure contains information of a specific authentication\n\t\t\t\t\t\tprofile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "DefaultSecurityLevelToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The default security level is used if none of the authentication policies\n\t\t\t\t\t\t\t\t\t\thas a schedule covering the time of access (or if no authentication policies\n\t\t\t\t\t\t\t\t\t\tare defined)." + }, + { + "name": "AuthenticationPolicy", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationPolicy", + "type_name": "AuthenticationPolicy", + "definition": { + "kind": "complexType", + "name": "AuthenticationPolicy", + "description": "The authentication policy is an association of a security level and a schedule. It defines when\n\t\t\t\t\t\ta certain security level is required to grant access to a credential holder. Each security \n\t\t\t\t\t\tlevel is given a unique priority. If authentication policies have overlapping schedules, \n\t\t\t\t\t\tthe security level with the highest priority is used.", + "fields": [ + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the schedule used by the authentication policy." + }, + { + "name": "SecurityLevelConstraint", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelConstraint", + "type_name": "SecurityLevelConstraint", + "definition": { + "kind": "complexType", + "name": "SecurityLevelConstraint", + "description": "This structure defines what security level should be active depending on the state of the\n\t\t\t\t\t\tschedule.", + "fields": [ + { + "name": "ActiveRegularSchedule", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Corresponds to the Active field in the ScheduleState structure in\n\t\t\t\t\t\t\t\t[ONVIF Schedule Service Specification]." + }, + { + "name": "ActiveSpecialDaySchedule", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Corresponds to the SpecialDay field in the ScheduleState structure in\n\t\t\t\t\t\t\t\t[ONVIF Schedule Service Specification].\n\t\t\t\t\t\t\t\tThis field will be ignored if the device do not support special days." + }, + { + "name": "AuthenticationMode", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines the mode of authentication. Authentication modes starting with the prefix\n\t\t\t\t\t\t\t\tpt: are reserved to define ONVIF-specific authentication modes. For custom defined\n\t\t\t\t\t\t\t\tauthentication modes, free text can be used.\n\t\t\t\t\t\t\t\tThe following authentication modes are defined by ONVIF:\n\t\t\t\t\t\t\t\tpt:SingleCredential - Normal mode where only one credential holder is required to be granted access.\n\t\t\t\t\t\t\t\tpt:DualCredential - Two credential holders are required to be granted access", + "default": "pt:SingleCredential" + }, + { + "name": "SecurityLevelToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the security level used by the authentication policy." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelConstraintExtension", + "type_name": "SecurityLevelConstraintExtension", + "definition": { + "kind": "complexType", + "name": "SecurityLevelConstraintExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of security level constraint structures defining the conditions\n\t\t\t\t\t\t\t\tfor what security level to use.\n\t\t\t\t\t\t\t\tMinimum one security level constraint must be specified." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationPolicyExtension", + "type_name": "AuthenticationPolicyExtension", + "definition": { + "kind": "complexType", + "name": "AuthenticationPolicyExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Each authentication policy associates a security level with a schedule (during\n\t\t\t\t\t\t\t\t\t\twhich the specified security level will be required at the access point)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfileExtension", + "type_name": "AuthenticationProfileExtension", + "definition": { + "kind": "complexType", + "name": "AuthenticationProfileExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The AuthenticationProfile to create." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}CreateAuthenticationProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}CreateAuthenticationProfileResponse", + "schema": { + "name": "CreateAuthenticationProfileResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The Token of created AuthenticationProfile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "SetAuthenticationProfile", + "port_type": "AuthenticationBehaviorPort", + "description": "This method is used to synchronize an authentication profile in a client with the device. If an authentication profile with the specified token does not exist in the device, the authentication profile is created. If an authentication profile with the specified token exists, then the authentication profile is modified. A call to this method takes an AuthenticationProfile structure as input parameter. The token field of the AuthenticationProfile shall not be empty. A device that signals support for the ClientSuppliedTokenSupported capability shall implement this command.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SetAuthenticationProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SetAuthenticationProfile", + "schema": { + "name": "SetAuthenticationProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AuthenticationProfile", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfile", + "type_name": "AuthenticationProfile", + "definition": { + "kind": "complexType", + "name": "AuthenticationProfile", + "description": "The AuthenticationProfile structure shall include all properties of the\n\t\t\t\t\t\tAuthenticationProfileInfo structure\n\t\t\t\t\t\tand also a default security level, an authentication mode, and a list of AuthenticationProfile\n\t\t\t\t\t\tinstances.", + "base": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfileInfo", + "base_definition": { + "kind": "complexType", + "name": "AuthenticationProfileInfo", + "description": "The AuthenticationProfileInfo structure contains information of a specific authentication\n\t\t\t\t\t\tprofile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "DefaultSecurityLevelToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The default security level is used if none of the authentication policies\n\t\t\t\t\t\t\t\t\t\thas a schedule covering the time of access (or if no authentication policies\n\t\t\t\t\t\t\t\t\t\tare defined)." + }, + { + "name": "AuthenticationPolicy", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationPolicy", + "type_name": "AuthenticationPolicy", + "definition": { + "kind": "complexType", + "name": "AuthenticationPolicy", + "description": "The authentication policy is an association of a security level and a schedule. It defines when\n\t\t\t\t\t\ta certain security level is required to grant access to a credential holder. Each security \n\t\t\t\t\t\tlevel is given a unique priority. If authentication policies have overlapping schedules, \n\t\t\t\t\t\tthe security level with the highest priority is used.", + "fields": [ + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the schedule used by the authentication policy." + }, + { + "name": "SecurityLevelConstraint", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelConstraint", + "type_name": "SecurityLevelConstraint", + "definition": { + "kind": "complexType", + "name": "SecurityLevelConstraint", + "description": "This structure defines what security level should be active depending on the state of the\n\t\t\t\t\t\tschedule.", + "fields": [ + { + "name": "ActiveRegularSchedule", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Corresponds to the Active field in the ScheduleState structure in\n\t\t\t\t\t\t\t\t[ONVIF Schedule Service Specification]." + }, + { + "name": "ActiveSpecialDaySchedule", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Corresponds to the SpecialDay field in the ScheduleState structure in\n\t\t\t\t\t\t\t\t[ONVIF Schedule Service Specification].\n\t\t\t\t\t\t\t\tThis field will be ignored if the device do not support special days." + }, + { + "name": "AuthenticationMode", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines the mode of authentication. Authentication modes starting with the prefix\n\t\t\t\t\t\t\t\tpt: are reserved to define ONVIF-specific authentication modes. For custom defined\n\t\t\t\t\t\t\t\tauthentication modes, free text can be used.\n\t\t\t\t\t\t\t\tThe following authentication modes are defined by ONVIF:\n\t\t\t\t\t\t\t\tpt:SingleCredential - Normal mode where only one credential holder is required to be granted access.\n\t\t\t\t\t\t\t\tpt:DualCredential - Two credential holders are required to be granted access", + "default": "pt:SingleCredential" + }, + { + "name": "SecurityLevelToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the security level used by the authentication policy." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelConstraintExtension", + "type_name": "SecurityLevelConstraintExtension", + "definition": { + "kind": "complexType", + "name": "SecurityLevelConstraintExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of security level constraint structures defining the conditions\n\t\t\t\t\t\t\t\tfor what security level to use.\n\t\t\t\t\t\t\t\tMinimum one security level constraint must be specified." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationPolicyExtension", + "type_name": "AuthenticationPolicyExtension", + "definition": { + "kind": "complexType", + "name": "AuthenticationPolicyExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Each authentication policy associates a security level with a schedule (during\n\t\t\t\t\t\t\t\t\t\twhich the specified security level will be required at the access point)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfileExtension", + "type_name": "AuthenticationProfileExtension", + "definition": { + "kind": "complexType", + "name": "AuthenticationProfileExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The AuthenticationProfile to create or modify." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SetAuthenticationProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SetAuthenticationProfileResponse", + "schema": { + "name": "SetAuthenticationProfileResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "ModifyAuthenticationProfile", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation modifies the specified authentication profile. The token of the authentication profile to modify is specified in the token field of the AuthenticationProfile structure and shall not be empty. All other fields in the structure shall overwrite the fields in the specified authentication profile.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}ModifyAuthenticationProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}ModifyAuthenticationProfile", + "schema": { + "name": "ModifyAuthenticationProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AuthenticationProfile", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfile", + "type_name": "AuthenticationProfile", + "definition": { + "kind": "complexType", + "name": "AuthenticationProfile", + "description": "The AuthenticationProfile structure shall include all properties of the\n\t\t\t\t\t\tAuthenticationProfileInfo structure\n\t\t\t\t\t\tand also a default security level, an authentication mode, and a list of AuthenticationProfile\n\t\t\t\t\t\tinstances.", + "base": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfileInfo", + "base_definition": { + "kind": "complexType", + "name": "AuthenticationProfileInfo", + "description": "The AuthenticationProfileInfo structure contains information of a specific authentication\n\t\t\t\t\t\tprofile instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "DefaultSecurityLevelToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The default security level is used if none of the authentication policies\n\t\t\t\t\t\t\t\t\t\thas a schedule covering the time of access (or if no authentication policies\n\t\t\t\t\t\t\t\t\t\tare defined)." + }, + { + "name": "AuthenticationPolicy", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationPolicy", + "type_name": "AuthenticationPolicy", + "definition": { + "kind": "complexType", + "name": "AuthenticationPolicy", + "description": "The authentication policy is an association of a security level and a schedule. It defines when\n\t\t\t\t\t\ta certain security level is required to grant access to a credential holder. Each security \n\t\t\t\t\t\tlevel is given a unique priority. If authentication policies have overlapping schedules, \n\t\t\t\t\t\tthe security level with the highest priority is used.", + "fields": [ + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the schedule used by the authentication policy." + }, + { + "name": "SecurityLevelConstraint", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelConstraint", + "type_name": "SecurityLevelConstraint", + "definition": { + "kind": "complexType", + "name": "SecurityLevelConstraint", + "description": "This structure defines what security level should be active depending on the state of the\n\t\t\t\t\t\tschedule.", + "fields": [ + { + "name": "ActiveRegularSchedule", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Corresponds to the Active field in the ScheduleState structure in\n\t\t\t\t\t\t\t\t[ONVIF Schedule Service Specification]." + }, + { + "name": "ActiveSpecialDaySchedule", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Corresponds to the SpecialDay field in the ScheduleState structure in\n\t\t\t\t\t\t\t\t[ONVIF Schedule Service Specification].\n\t\t\t\t\t\t\t\tThis field will be ignored if the device do not support special days." + }, + { + "name": "AuthenticationMode", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines the mode of authentication. Authentication modes starting with the prefix\n\t\t\t\t\t\t\t\tpt: are reserved to define ONVIF-specific authentication modes. For custom defined\n\t\t\t\t\t\t\t\tauthentication modes, free text can be used.\n\t\t\t\t\t\t\t\tThe following authentication modes are defined by ONVIF:\n\t\t\t\t\t\t\t\tpt:SingleCredential - Normal mode where only one credential holder is required to be granted access.\n\t\t\t\t\t\t\t\tpt:DualCredential - Two credential holders are required to be granted access", + "default": "pt:SingleCredential" + }, + { + "name": "SecurityLevelToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the security level used by the authentication policy." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelConstraintExtension", + "type_name": "SecurityLevelConstraintExtension", + "definition": { + "kind": "complexType", + "name": "SecurityLevelConstraintExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of security level constraint structures defining the conditions\n\t\t\t\t\t\t\t\tfor what security level to use.\n\t\t\t\t\t\t\t\tMinimum one security level constraint must be specified." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationPolicyExtension", + "type_name": "AuthenticationPolicyExtension", + "definition": { + "kind": "complexType", + "name": "AuthenticationPolicyExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Each authentication policy associates a security level with a schedule (during\n\t\t\t\t\t\t\t\t\t\twhich the specified security level will be required at the access point)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}AuthenticationProfileExtension", + "type_name": "AuthenticationProfileExtension", + "definition": { + "kind": "complexType", + "name": "AuthenticationProfileExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The AuthenticationProfile to modify." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}ModifyAuthenticationProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}ModifyAuthenticationProfileResponse", + "schema": { + "name": "ModifyAuthenticationProfileResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "DeleteAuthenticationProfile", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation deletes the specified authentication profile. If the authentication profile is deleted, all authentication policies associated with the authentication profile will also be deleted. If it is associated with one or more entities some devices may not be able to delete the authentication profile, and consequently a ReferenceInUse fault shall be generated.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}DeleteAuthenticationProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}DeleteAuthenticationProfile", + "schema": { + "name": "DeleteAuthenticationProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the AuthenticationProfile to delete." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}DeleteAuthenticationProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}DeleteAuthenticationProfileResponse", + "schema": { + "name": "DeleteAuthenticationProfileResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "GetSecurityLevelInfo", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation requests a list of SecurityLevelInfo items matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. The device shall not return a fault in this case.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelInfoRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelInfo", + "schema": { + "name": "GetSecurityLevelInfo", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of SecurityLevelInfo items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelInfoResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelInfoResponse", + "schema": { + "name": "GetSecurityLevelInfoResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SecurityLevelInfo", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelInfo", + "type_name": "SecurityLevelInfo", + "definition": { + "kind": "complexType", + "name": "SecurityLevelInfo", + "description": "The SecurityLevelInfo structure contains information of a specific security level instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A higher number indicates that the security level is considered more secure\n\t\t\t\t\t\t\t\t\t\tthan security levels with lower priorities. The priority is used when an\n\t\t\t\t\t\t\t\t\t\tauthentication profile have overlapping schedules with different security\n\t\t\t\t\t\t\t\t\t\tlevels. When an access point is accessed, the authentication policies are\n\t\t\t\t\t\t\t\t\t\twalked through in priority order (highest priority first). When a schedule is\n\t\t\t\t\t\t\t\t\t\tfound covering the time of access, the associated security level is used and\n\t\t\t\t\t\t\t\t\t\tprocessing stops. Two security levels cannot have the same priority." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SecurityLevelInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "GetSecurityLevelInfoList", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation requests a list of all of SecurityLevelInfo items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer Access Control Service Specification for more details. The number of items returned shall not be greater than Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelInfoListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelInfoList", + "schema": { + "name": "GetSecurityLevelInfoList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is determined by the\n\t\t\t\t\t\t\t\t\tdevice." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelInfoListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelInfoListResponse", + "schema": { + "name": "GetSecurityLevelInfoListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "SecurityLevelInfo", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelInfo", + "type_name": "SecurityLevelInfo", + "definition": { + "kind": "complexType", + "name": "SecurityLevelInfo", + "description": "The SecurityLevelInfo structure contains information of a specific security level instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A higher number indicates that the security level is considered more secure\n\t\t\t\t\t\t\t\t\t\tthan security levels with lower priorities. The priority is used when an\n\t\t\t\t\t\t\t\t\t\tauthentication profile have overlapping schedules with different security\n\t\t\t\t\t\t\t\t\t\tlevels. When an access point is accessed, the authentication policies are\n\t\t\t\t\t\t\t\t\t\twalked through in priority order (highest priority first). When a schedule is\n\t\t\t\t\t\t\t\t\t\tfound covering the time of access, the associated security level is used and\n\t\t\t\t\t\t\t\t\t\tprocessing stops. Two security levels cannot have the same priority." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SecurityLevelInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "GetSecurityLevels", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation returns the specified SecurityLevel item matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching specified tokens. The device shall not return a fault in this case.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevels", + "schema": { + "name": "GetSecurityLevels", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of SecurityLevel items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelsResponse", + "schema": { + "name": "GetSecurityLevelsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SecurityLevel", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevel", + "type_name": "SecurityLevel", + "definition": { + "kind": "complexType", + "name": "SecurityLevel", + "description": "The SecurityLevel structure shall include all properties of the SecurityLevelInfo structure and\n\t\t\t\t\t\talso a set\n\t\t\t\t\t\tof recognition groups.\n\n\t\t\t\t\t\tThe recognition groups are used to define a logical OR between the groups. Each recognition\n\t\t\t\t\t\tgroup consists\n\t\t\t\t\t\tof one or more recognition methods.", + "base": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelInfo", + "base_definition": { + "kind": "complexType", + "name": "SecurityLevelInfo", + "description": "The SecurityLevelInfo structure contains information of a specific security level instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A higher number indicates that the security level is considered more secure\n\t\t\t\t\t\t\t\t\t\tthan security levels with lower priorities. The priority is used when an\n\t\t\t\t\t\t\t\t\t\tauthentication profile have overlapping schedules with different security\n\t\t\t\t\t\t\t\t\t\tlevels. When an access point is accessed, the authentication policies are\n\t\t\t\t\t\t\t\t\t\twalked through in priority order (highest priority first). When a schedule is\n\t\t\t\t\t\t\t\t\t\tfound covering the time of access, the associated security level is used and\n\t\t\t\t\t\t\t\t\t\tprocessing stops. Two security levels cannot have the same priority." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "RecognitionGroup", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionGroup", + "type_name": "RecognitionGroup", + "definition": { + "kind": "complexType", + "name": "RecognitionGroup", + "fields": [ + { + "name": "RecognitionMethod", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionMethod", + "type_name": "RecognitionMethod", + "definition": { + "kind": "complexType", + "name": "RecognitionMethod", + "description": "Recognition is the action of identifying authorized users requesting access by the comparison of\n\t\t\t\t\t\tpresented\n\t\t\t\t\t\tcredential data with recorded credential data. A recognition method is either memorized,\n\t\t\t\t\t\tbiometric or held\n\t\t\t\t\t\twithin a physical credential. A recognition type is either a recognition method or a physical\n\t\t\t\t\t\tinput such as\n\t\t\t\t\t\ta request-to-exit button.", + "fields": [ + { + "name": "RecognitionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested type of recognition. Is of type text.\n\t\t\t\t\t\t\t\tRecognition types starting with the prefix pt: are reserved to define \n\t\t\t\t\t\t\t\tONVIF-specific types as defined in pt:RecognitionType. For custom defined \n\t\t\t\t\t\t\t\tidentifier types, free text can be used." + }, + { + "name": "Order", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The order value defines when this recognition method will be requested in relation \n\t\t\t\t\t\t\t\tto the other recognition methods in the same security level. A lower number indicates \n\t\t\t\t\t\t\t\tthat the recognition method will be requested before recognition methods with a higher number." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionMethodExtension", + "type_name": "RecognitionMethodExtension", + "definition": { + "kind": "complexType", + "name": "RecognitionMethodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of recognition methods to request for at the access point." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionGroupExtension", + "type_name": "RecognitionGroupExtension", + "definition": { + "kind": "complexType", + "name": "RecognitionGroupExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The recognition groups are used to define a logical OR between the groups. Each\n\t\t\t\t\t\t\t\t\t\trecognition group consists of one or more recognition methods." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelExtension", + "type_name": "SecurityLevelExtension", + "definition": { + "kind": "complexType", + "name": "SecurityLevelExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SecurityLevel items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "GetSecurityLevelList", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation requests a list of all of SecurityLevel items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer Access Control Service Specification for more details. The number of items returned shall not be greater the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelList", + "schema": { + "name": "GetSecurityLevelList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is determined by the\n\t\t\t\t\t\t\t\t\tdevice." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}GetSecurityLevelListResponse", + "schema": { + "name": "GetSecurityLevelListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "SecurityLevel", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevel", + "type_name": "SecurityLevel", + "definition": { + "kind": "complexType", + "name": "SecurityLevel", + "description": "The SecurityLevel structure shall include all properties of the SecurityLevelInfo structure and\n\t\t\t\t\t\talso a set\n\t\t\t\t\t\tof recognition groups.\n\n\t\t\t\t\t\tThe recognition groups are used to define a logical OR between the groups. Each recognition\n\t\t\t\t\t\tgroup consists\n\t\t\t\t\t\tof one or more recognition methods.", + "base": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelInfo", + "base_definition": { + "kind": "complexType", + "name": "SecurityLevelInfo", + "description": "The SecurityLevelInfo structure contains information of a specific security level instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A higher number indicates that the security level is considered more secure\n\t\t\t\t\t\t\t\t\t\tthan security levels with lower priorities. The priority is used when an\n\t\t\t\t\t\t\t\t\t\tauthentication profile have overlapping schedules with different security\n\t\t\t\t\t\t\t\t\t\tlevels. When an access point is accessed, the authentication policies are\n\t\t\t\t\t\t\t\t\t\twalked through in priority order (highest priority first). When a schedule is\n\t\t\t\t\t\t\t\t\t\tfound covering the time of access, the associated security level is used and\n\t\t\t\t\t\t\t\t\t\tprocessing stops. Two security levels cannot have the same priority." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "RecognitionGroup", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionGroup", + "type_name": "RecognitionGroup", + "definition": { + "kind": "complexType", + "name": "RecognitionGroup", + "fields": [ + { + "name": "RecognitionMethod", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionMethod", + "type_name": "RecognitionMethod", + "definition": { + "kind": "complexType", + "name": "RecognitionMethod", + "description": "Recognition is the action of identifying authorized users requesting access by the comparison of\n\t\t\t\t\t\tpresented\n\t\t\t\t\t\tcredential data with recorded credential data. A recognition method is either memorized,\n\t\t\t\t\t\tbiometric or held\n\t\t\t\t\t\twithin a physical credential. A recognition type is either a recognition method or a physical\n\t\t\t\t\t\tinput such as\n\t\t\t\t\t\ta request-to-exit button.", + "fields": [ + { + "name": "RecognitionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested type of recognition. Is of type text.\n\t\t\t\t\t\t\t\tRecognition types starting with the prefix pt: are reserved to define \n\t\t\t\t\t\t\t\tONVIF-specific types as defined in pt:RecognitionType. For custom defined \n\t\t\t\t\t\t\t\tidentifier types, free text can be used." + }, + { + "name": "Order", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The order value defines when this recognition method will be requested in relation \n\t\t\t\t\t\t\t\tto the other recognition methods in the same security level. A lower number indicates \n\t\t\t\t\t\t\t\tthat the recognition method will be requested before recognition methods with a higher number." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionMethodExtension", + "type_name": "RecognitionMethodExtension", + "definition": { + "kind": "complexType", + "name": "RecognitionMethodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of recognition methods to request for at the access point." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionGroupExtension", + "type_name": "RecognitionGroupExtension", + "definition": { + "kind": "complexType", + "name": "RecognitionGroupExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The recognition groups are used to define a logical OR between the groups. Each\n\t\t\t\t\t\t\t\t\t\trecognition group consists of one or more recognition methods." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelExtension", + "type_name": "SecurityLevelExtension", + "definition": { + "kind": "complexType", + "name": "SecurityLevelExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SecurityLevel items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "CreateSecurityLevel", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation creates the specified security level in the device. The token field of the SecurityLevel structure shall be empty and the device shall allocate a token for the security level. The allocated token shall be returned in the response. If the client sends any value in the token field, the device shall return InvalidArgVal as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}CreateSecurityLevelRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}CreateSecurityLevel", + "schema": { + "name": "CreateSecurityLevel", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SecurityLevel", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevel", + "type_name": "SecurityLevel", + "definition": { + "kind": "complexType", + "name": "SecurityLevel", + "description": "The SecurityLevel structure shall include all properties of the SecurityLevelInfo structure and\n\t\t\t\t\t\talso a set\n\t\t\t\t\t\tof recognition groups.\n\n\t\t\t\t\t\tThe recognition groups are used to define a logical OR between the groups. Each recognition\n\t\t\t\t\t\tgroup consists\n\t\t\t\t\t\tof one or more recognition methods.", + "base": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelInfo", + "base_definition": { + "kind": "complexType", + "name": "SecurityLevelInfo", + "description": "The SecurityLevelInfo structure contains information of a specific security level instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A higher number indicates that the security level is considered more secure\n\t\t\t\t\t\t\t\t\t\tthan security levels with lower priorities. The priority is used when an\n\t\t\t\t\t\t\t\t\t\tauthentication profile have overlapping schedules with different security\n\t\t\t\t\t\t\t\t\t\tlevels. When an access point is accessed, the authentication policies are\n\t\t\t\t\t\t\t\t\t\twalked through in priority order (highest priority first). When a schedule is\n\t\t\t\t\t\t\t\t\t\tfound covering the time of access, the associated security level is used and\n\t\t\t\t\t\t\t\t\t\tprocessing stops. Two security levels cannot have the same priority." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "RecognitionGroup", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionGroup", + "type_name": "RecognitionGroup", + "definition": { + "kind": "complexType", + "name": "RecognitionGroup", + "fields": [ + { + "name": "RecognitionMethod", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionMethod", + "type_name": "RecognitionMethod", + "definition": { + "kind": "complexType", + "name": "RecognitionMethod", + "description": "Recognition is the action of identifying authorized users requesting access by the comparison of\n\t\t\t\t\t\tpresented\n\t\t\t\t\t\tcredential data with recorded credential data. A recognition method is either memorized,\n\t\t\t\t\t\tbiometric or held\n\t\t\t\t\t\twithin a physical credential. A recognition type is either a recognition method or a physical\n\t\t\t\t\t\tinput such as\n\t\t\t\t\t\ta request-to-exit button.", + "fields": [ + { + "name": "RecognitionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested type of recognition. Is of type text.\n\t\t\t\t\t\t\t\tRecognition types starting with the prefix pt: are reserved to define \n\t\t\t\t\t\t\t\tONVIF-specific types as defined in pt:RecognitionType. For custom defined \n\t\t\t\t\t\t\t\tidentifier types, free text can be used." + }, + { + "name": "Order", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The order value defines when this recognition method will be requested in relation \n\t\t\t\t\t\t\t\tto the other recognition methods in the same security level. A lower number indicates \n\t\t\t\t\t\t\t\tthat the recognition method will be requested before recognition methods with a higher number." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionMethodExtension", + "type_name": "RecognitionMethodExtension", + "definition": { + "kind": "complexType", + "name": "RecognitionMethodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of recognition methods to request for at the access point." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionGroupExtension", + "type_name": "RecognitionGroupExtension", + "definition": { + "kind": "complexType", + "name": "RecognitionGroupExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The recognition groups are used to define a logical OR between the groups. Each\n\t\t\t\t\t\t\t\t\t\trecognition group consists of one or more recognition methods." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelExtension", + "type_name": "SecurityLevelExtension", + "definition": { + "kind": "complexType", + "name": "SecurityLevelExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The SecurityLevel to create." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}CreateSecurityLevelResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}CreateSecurityLevelResponse", + "schema": { + "name": "CreateSecurityLevelResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The Token of created SecurityLevel." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "SetSecurityLevel", + "port_type": "AuthenticationBehaviorPort", + "description": "This method is used to synchronize an security level in a client with the device. If an security level with the specified token does not exist in the device, the security level is created. If an security level with the specified token exists, then the security level is modified. A call to this method takes an SecurityLevel structure as input parameter. The token field of the SecurityLevel shall not be empty. A device that signals support for the ClientSuppliedTokenSupported capability shall implement this command.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SetSecurityLevelRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SetSecurityLevel", + "schema": { + "name": "SetSecurityLevel", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SecurityLevel", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevel", + "type_name": "SecurityLevel", + "definition": { + "kind": "complexType", + "name": "SecurityLevel", + "description": "The SecurityLevel structure shall include all properties of the SecurityLevelInfo structure and\n\t\t\t\t\t\talso a set\n\t\t\t\t\t\tof recognition groups.\n\n\t\t\t\t\t\tThe recognition groups are used to define a logical OR between the groups. Each recognition\n\t\t\t\t\t\tgroup consists\n\t\t\t\t\t\tof one or more recognition methods.", + "base": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelInfo", + "base_definition": { + "kind": "complexType", + "name": "SecurityLevelInfo", + "description": "The SecurityLevelInfo structure contains information of a specific security level instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A higher number indicates that the security level is considered more secure\n\t\t\t\t\t\t\t\t\t\tthan security levels with lower priorities. The priority is used when an\n\t\t\t\t\t\t\t\t\t\tauthentication profile have overlapping schedules with different security\n\t\t\t\t\t\t\t\t\t\tlevels. When an access point is accessed, the authentication policies are\n\t\t\t\t\t\t\t\t\t\twalked through in priority order (highest priority first). When a schedule is\n\t\t\t\t\t\t\t\t\t\tfound covering the time of access, the associated security level is used and\n\t\t\t\t\t\t\t\t\t\tprocessing stops. Two security levels cannot have the same priority." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "RecognitionGroup", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionGroup", + "type_name": "RecognitionGroup", + "definition": { + "kind": "complexType", + "name": "RecognitionGroup", + "fields": [ + { + "name": "RecognitionMethod", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionMethod", + "type_name": "RecognitionMethod", + "definition": { + "kind": "complexType", + "name": "RecognitionMethod", + "description": "Recognition is the action of identifying authorized users requesting access by the comparison of\n\t\t\t\t\t\tpresented\n\t\t\t\t\t\tcredential data with recorded credential data. A recognition method is either memorized,\n\t\t\t\t\t\tbiometric or held\n\t\t\t\t\t\twithin a physical credential. A recognition type is either a recognition method or a physical\n\t\t\t\t\t\tinput such as\n\t\t\t\t\t\ta request-to-exit button.", + "fields": [ + { + "name": "RecognitionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested type of recognition. Is of type text.\n\t\t\t\t\t\t\t\tRecognition types starting with the prefix pt: are reserved to define \n\t\t\t\t\t\t\t\tONVIF-specific types as defined in pt:RecognitionType. For custom defined \n\t\t\t\t\t\t\t\tidentifier types, free text can be used." + }, + { + "name": "Order", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The order value defines when this recognition method will be requested in relation \n\t\t\t\t\t\t\t\tto the other recognition methods in the same security level. A lower number indicates \n\t\t\t\t\t\t\t\tthat the recognition method will be requested before recognition methods with a higher number." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionMethodExtension", + "type_name": "RecognitionMethodExtension", + "definition": { + "kind": "complexType", + "name": "RecognitionMethodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of recognition methods to request for at the access point." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionGroupExtension", + "type_name": "RecognitionGroupExtension", + "definition": { + "kind": "complexType", + "name": "RecognitionGroupExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The recognition groups are used to define a logical OR between the groups. Each\n\t\t\t\t\t\t\t\t\t\trecognition group consists of one or more recognition methods." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelExtension", + "type_name": "SecurityLevelExtension", + "definition": { + "kind": "complexType", + "name": "SecurityLevelExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The SecurityLevel to create or modify." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SetSecurityLevelResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SetSecurityLevelResponse", + "schema": { + "name": "SetSecurityLevelResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "ModifySecurityLevel", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation modifies the specified security level. The token of the security level to modify is specified in the token field of the SecurityLevel structure and shall not be empty. All other fields in the structure shall overwrite the fields in the specified security level.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}ModifySecurityLevelRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}ModifySecurityLevel", + "schema": { + "name": "ModifySecurityLevel", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SecurityLevel", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevel", + "type_name": "SecurityLevel", + "definition": { + "kind": "complexType", + "name": "SecurityLevel", + "description": "The SecurityLevel structure shall include all properties of the SecurityLevelInfo structure and\n\t\t\t\t\t\talso a set\n\t\t\t\t\t\tof recognition groups.\n\n\t\t\t\t\t\tThe recognition groups are used to define a logical OR between the groups. Each recognition\n\t\t\t\t\t\tgroup consists\n\t\t\t\t\t\tof one or more recognition methods.", + "base": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelInfo", + "base_definition": { + "kind": "complexType", + "name": "SecurityLevelInfo", + "description": "The SecurityLevelInfo structure contains information of a specific security level instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A higher number indicates that the security level is considered more secure\n\t\t\t\t\t\t\t\t\t\tthan security levels with lower priorities. The priority is used when an\n\t\t\t\t\t\t\t\t\t\tauthentication profile have overlapping schedules with different security\n\t\t\t\t\t\t\t\t\t\tlevels. When an access point is accessed, the authentication policies are\n\t\t\t\t\t\t\t\t\t\twalked through in priority order (highest priority first). When a schedule is\n\t\t\t\t\t\t\t\t\t\tfound covering the time of access, the associated security level is used and\n\t\t\t\t\t\t\t\t\t\tprocessing stops. Two security levels cannot have the same priority." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the access profile. It shall be up\n\t\t\t\t\t\t\t\t\t\tto 1024 characters." + } + ] + }, + "fields": [ + { + "name": "RecognitionGroup", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionGroup", + "type_name": "RecognitionGroup", + "definition": { + "kind": "complexType", + "name": "RecognitionGroup", + "fields": [ + { + "name": "RecognitionMethod", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionMethod", + "type_name": "RecognitionMethod", + "definition": { + "kind": "complexType", + "name": "RecognitionMethod", + "description": "Recognition is the action of identifying authorized users requesting access by the comparison of\n\t\t\t\t\t\tpresented\n\t\t\t\t\t\tcredential data with recorded credential data. A recognition method is either memorized,\n\t\t\t\t\t\tbiometric or held\n\t\t\t\t\t\twithin a physical credential. A recognition type is either a recognition method or a physical\n\t\t\t\t\t\tinput such as\n\t\t\t\t\t\ta request-to-exit button.", + "fields": [ + { + "name": "RecognitionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested type of recognition. Is of type text.\n\t\t\t\t\t\t\t\tRecognition types starting with the prefix pt: are reserved to define \n\t\t\t\t\t\t\t\tONVIF-specific types as defined in pt:RecognitionType. For custom defined \n\t\t\t\t\t\t\t\tidentifier types, free text can be used." + }, + { + "name": "Order", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The order value defines when this recognition method will be requested in relation \n\t\t\t\t\t\t\t\tto the other recognition methods in the same security level. A lower number indicates \n\t\t\t\t\t\t\t\tthat the recognition method will be requested before recognition methods with a higher number." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionMethodExtension", + "type_name": "RecognitionMethodExtension", + "definition": { + "kind": "complexType", + "name": "RecognitionMethodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of recognition methods to request for at the access point." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}RecognitionGroupExtension", + "type_name": "RecognitionGroupExtension", + "definition": { + "kind": "complexType", + "name": "RecognitionGroupExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The recognition groups are used to define a logical OR between the groups. Each\n\t\t\t\t\t\t\t\t\t\trecognition group consists of one or more recognition methods." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}SecurityLevelExtension", + "type_name": "SecurityLevelExtension", + "definition": { + "kind": "complexType", + "name": "SecurityLevelExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The SecurityLevel to modify." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}ModifySecurityLevelResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}ModifySecurityLevelResponse", + "schema": { + "name": "ModifySecurityLevelResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + }, + { + "name": "DeleteSecurityLevel", + "port_type": "AuthenticationBehaviorPort", + "description": "This operation deletes the specified security level. If the security level is deleted, all authentication policies associated with the security level will also be deleted. If it is associated with one or more entities some devices may not be able to delete the security level, and consequently a ReferenceInUse fault shall be generated.", + "input": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}DeleteSecurityLevelRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}DeleteSecurityLevel", + "schema": { + "name": "DeleteSecurityLevel", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the SecurityLevel to delete." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}DeleteSecurityLevelResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/authenticationbehavior/wsdl}DeleteSecurityLevelResponse", + "schema": { + "name": "DeleteSecurityLevelResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AuthenticationBehaviorBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/credential/wsdl/credential.json b/docs/generated/wsdl/ver10/credential/wsdl/credential.json new file mode 100644 index 00000000..2807b55c --- /dev/null +++ b/docs/generated/wsdl/ver10/credential/wsdl/credential.json @@ -0,0 +1,4916 @@ +{ + "source": "ver10/credential/wsdl/credential.wsdl", + "target_namespace": "http://www.onvif.org/ver10/credential/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "CredentialPort", + "description": "This operation returns the capabilities of the credential service.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/credential/wsdl}ServiceCapabilities", + "type_name": "ServiceCapabilities", + "definition": { + "kind": "complexType", + "name": "ServiceCapabilities", + "description": "The service capabilities reflect optional functionality of a service. The information is static\n\t\t\t\t\t\tand does not change during device operation. The following capabilities are available:", + "fields": [ + { + "name": "SupportedIdentifierType", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of identifier types that the device supports. Is of type text.\n\t\t\t\t\t\t\t\tIdentifier types starting with the prefix pt: are reserved to define ONVIF-specific\n\t\t\t\t\t\t\t\ttypes as defined in pt:RecognitionType. Please note that pt:REX is not an identifier\n\t\t\t\t\t\t\t\ttype. For custom defined identifier types, free text can be used." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/credential/wsdl}ServiceCapabilitiesExtension", + "type_name": "ServiceCapabilitiesExtension", + "definition": { + "kind": "complexType", + "name": "ServiceCapabilitiesExtension", + "fields": [ + { + "name": "SupportedExemptionType", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of exemptions that the device supports. Supported exemptions starting with the\n\t prefix pt: are reserved to define ONVIF specific exemption types and these reserved\n\t exemption types shall all share \"pt:<Name>\" syntax." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "MaxLimit", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "The maximum number of entries returned by a single Get<Entity>List or Get<Entity>\n\t\t\t\t\t\t\trequest. The device shall never return more than this number of entities in a single response." + }, + { + "use": "required", + "name": "CredentialValiditySupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that the device supports credential validity." + }, + { + "use": "required", + "name": "CredentialAccessProfileValiditySupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that the device supports validity on the association between a credential and an\n\t\t\t\t\t\t\taccess profile." + }, + { + "use": "required", + "name": "ValiditySupportsTimeValue", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that the device supports both date and time value for validity. If set to false,\n\t\t\t\t\t\t\tthen the time value is ignored." + }, + { + "use": "required", + "name": "MaxCredentials", + "type": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "description": "The maximum number of credential supported by the device.\n\t\t\t\t\t\t\tIf set to 0, then operations using credential token are not supported." + }, + { + "use": "required", + "name": "MaxAccessProfilesPerCredential", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "The maximum number of access profiles for a credential." + }, + { + "use": "required", + "name": "ResetAntipassbackSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates the device supports resetting of anti-passback violations and notifying on\n\t\t\t\t\t\t\tanti-passback violations." + }, + { + "use": "optional", + "name": "ClientSuppliedTokenSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false", + "description": "Indicates that the client is allowed to supply the token when creating credentials. \n\t\t\t\t\t\t\tTo enable the use of the command SetCredential, the value must be set to true." + }, + { + "use": "optional", + "name": "DefaultCredentialSuspensionDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "default": "PT5M", + "description": "The default time period that the credential will temporary be suspended (e.g. by using\n\t\t\t\t\t\t\tthe wrong PIN a predetermined number of times).\n\t\t\t\t\t\t\tThe time period is defined as an [ISO 8601] duration string (e.g. \"PT5M\")." + }, + { + "use": "optional", + "name": "MaxWhitelistedItems", + "type": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "default": "0", + "description": "The maximum number of whitelisted credential identifiers supported by the device." + }, + { + "use": "optional", + "name": "MaxBlacklistedItems", + "type": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "default": "0", + "description": "The maximum number of blacklisted credential identifiers supported by the device." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capability response message contains the requested credential\n\t\t\t\t\t\t\t\t\tservice capabilities using a hierarchical XML capability structure." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "GetSupportedFormatTypes", + "port_type": "CredentialPort", + "description": "This method returns all the supported format types of a specified identifier type that is supported by the device.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetSupportedFormatTypesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetSupportedFormatTypes", + "schema": { + "name": "GetSupportedFormatTypes", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CredentialIdentifierTypeName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Name of the credential identifier type" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetSupportedFormatTypesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetSupportedFormatTypesResponse", + "schema": { + "name": "GetSupportedFormatTypesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "FormatTypeInfo", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierFormatTypeInfo", + "type_name": "CredentialIdentifierFormatTypeInfo", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierFormatTypeInfo", + "description": "Contains information about a format type.", + "fields": [ + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A format type supported by the device. A list of supported format types is\n\t\t\t\t\t\t\t\tprovided in [ISO 16484-5:2014-09 Annex P]. The BACnet type \"CUSTOM\" is not used in this\n\t\t\t\t\t\t\t\tspecification. Instead device manufacturers can define their own format types." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable description of the credential identifier format type. It\n\t\t\t\t\t\t\t\tshall be up to 1024 characters. For custom types, it is recommended to describe how the\n\t\t\t\t\t\t\t\toctet string is encoded (following the structure in column Authentication Factor Value\n\t\t\t\t\t\t\t\tEncoding of [ISO 16484-5:2014-09 Annex P])." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierFormatTypeInfoExtension", + "type_name": "CredentialIdentifierFormatTypeInfoExtension", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierFormatTypeInfoExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Identifier format type" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "GetCredentialInfo", + "port_type": "CredentialPort", + "description": "This operation requests a list of CredentialInfo items matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialInfoRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialInfo", + "schema": { + "name": "GetCredentialInfo", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of CredentialInfo items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialInfoResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialInfoResponse", + "schema": { + "name": "GetCredentialInfoResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CredentialInfo", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialInfo", + "type_name": "CredentialInfo", + "definition": { + "kind": "complexType", + "name": "CredentialInfo", + "description": "The CredentialInfo type represents the credential as a logical object. The structure contains\n\t\t\t\t\t\tthe basic information of a specific credential instance. The device shall provide the following\n\t\t\t\t\t\tfields for each credential.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the credential. It shall be up to 1024 characters." + }, + { + "name": "CredentialHolderReference", + "definition": { + "kind": "simpleType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "An external reference to a person holding this credential. The\n\t\t\t\t\t\t\t\t\t\treference is a username or used ID in an external system, such as a directory\n\t\t\t\t\t\t\t\t\t\tservice." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The expiration date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of CredentialInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "GetCredentialInfoList", + "port_type": "CredentialPort", + "description": "This operation requests a list of all CredentialInfo items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer to section 4.8.3 in [ONVIF Access Control Service Specification] for more details. The number of items returned shall not be greater than the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialInfoListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialInfoList", + "schema": { + "name": "GetCredentialInfoList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is determined by the\n\t\t\t\t\t\t\t\t\tdevice." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialInfoListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialInfoListResponse", + "schema": { + "name": "GetCredentialInfoListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "CredentialInfo", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialInfo", + "type_name": "CredentialInfo", + "definition": { + "kind": "complexType", + "name": "CredentialInfo", + "description": "The CredentialInfo type represents the credential as a logical object. The structure contains\n\t\t\t\t\t\tthe basic information of a specific credential instance. The device shall provide the following\n\t\t\t\t\t\tfields for each credential.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the credential. It shall be up to 1024 characters." + }, + { + "name": "CredentialHolderReference", + "definition": { + "kind": "simpleType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "An external reference to a person holding this credential. The\n\t\t\t\t\t\t\t\t\t\treference is a username or used ID in an external system, such as a directory\n\t\t\t\t\t\t\t\t\t\tservice." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The expiration date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of CredentialInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "GetCredentials", + "port_type": "CredentialPort", + "description": "This operation returns the specified credential items matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentials", + "schema": { + "name": "GetCredentials", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Token of Credentials to get" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialsResponse", + "schema": { + "name": "GetCredentialsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Credential", + "type": "{http://www.onvif.org/ver10/credential/wsdl}Credential", + "type_name": "Credential", + "definition": { + "kind": "complexType", + "name": "Credential", + "description": "A Credential is a physical/tangible object, a piece of knowledge, or a facet of a person's\n\t\t\t\t\t\tphysical being, that enables an individual access to a given physical facility or computer-based\n\t\t\t\t\t\tinformation system. A credential holds one or more credential identifiers. To gain access one or\n\t\t\t\t\t\tmore identifiers may be required.", + "base": "{http://www.onvif.org/ver10/credential/wsdl}CredentialInfo", + "base_definition": { + "kind": "complexType", + "name": "CredentialInfo", + "description": "The CredentialInfo type represents the credential as a logical object. The structure contains\n\t\t\t\t\t\tthe basic information of a specific credential instance. The device shall provide the following\n\t\t\t\t\t\tfields for each credential.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the credential. It shall be up to 1024 characters." + }, + { + "name": "CredentialHolderReference", + "definition": { + "kind": "simpleType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "An external reference to a person holding this credential. The\n\t\t\t\t\t\t\t\t\t\treference is a username or used ID in an external system, such as a directory\n\t\t\t\t\t\t\t\t\t\tservice." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The expiration date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "CredentialIdentifier", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifier", + "type_name": "CredentialIdentifier", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifier", + "description": "A credential identifier is a card number, unique card information, PIN or\n\t\t\t\t\t\tbiometric information such as fingerprint, iris, vein, face recognition, that can be validated\n\t\t\t\t\t\tin an access point.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierType", + "type_name": "CredentialIdentifierType", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierType", + "description": "Specifies the name of credential identifier type and its format for the credential\n\t\t\t\t\t\tvalue.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the credential identifier type, such as pt:Card, pt:PIN,\n\t\t\t\t\t\t\t\tetc." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the format of the credential value for the specified identifier\n\t\t\t\t\t\t\t\ttype name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the details of the credential identifier type. Is of type\n\t\t\t\t\t\t\t\tCredentialIdentifierType." + }, + { + "name": "ExemptedFromAuthentication", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If set to true, this credential identifier is not considered for \n authentication. For example if the access point requests Card plus PIN, and the credential \n identifier of type PIN is exempted from authentication, then the access point will not prompt \n for the PIN." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the identifier in hexadecimal representation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential identifier structures. At least one\n\t\t\t\t\t\t\t\t\t\tcredential identifier is required. Maximum one credential identifier structure\n\t\t\t\t\t\t\t\t\t\tper type is allowed." + }, + { + "name": "CredentialAccessProfile", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialAccessProfile", + "type_name": "CredentialAccessProfile", + "definition": { + "kind": "complexType", + "name": "CredentialAccessProfile", + "description": "The association between a credential and an access profile.", + "fields": [ + { + "name": "AccessProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The reference token of the associated access profile." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The end date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential access profile structures." + }, + { + "name": "ExtendedGrantTime", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A boolean indicating that the credential holder needs extra time to get through the door. \n\t\t\t\t\t\t\t\t\t\tExtendedReleaseTime will be added to ReleaseTime, and ExtendedOpenTime will be added to OpenTime", + "default": "false" + }, + { + "name": "Attribute", + "type": "{http://www.onvif.org/ver10/pacs}Attribute", + "type_name": "Attribute", + "definition": { + "kind": "complexType", + "name": "Attribute", + "description": "Attributes contains a Name and an optional Value and type.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of attribute. Key names starting with \"ONVIF\" (any case) are reserved for ONVIF\n\t\t\t\t\tuse." + }, + { + "use": "optional", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Value of attribute." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential attributes as name value pairs. Key names\n\t\t\t\t\t\t\t\t\t\tstarting with the prefix pt: are reserved to define PACS specific attributes\n\t\t\t\t\t\t\t\t\t\tfollowing the \"pt:<Name>\" syntax." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialExtension", + "type_name": "CredentialExtension", + "definition": { + "kind": "complexType", + "name": "CredentialExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of Credential items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "GetCredentialList", + "port_type": "CredentialPort", + "description": "This operation requests a list of all credential items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer section 4.8.3 in [Access Control Service Specification] for more details. The number of items returned shall not be greater the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialList", + "schema": { + "name": "GetCredentialList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is determined by the\n\t\t\t\t\t\t\t\t\tdevice." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialListResponse", + "schema": { + "name": "GetCredentialListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "Credential", + "type": "{http://www.onvif.org/ver10/credential/wsdl}Credential", + "type_name": "Credential", + "definition": { + "kind": "complexType", + "name": "Credential", + "description": "A Credential is a physical/tangible object, a piece of knowledge, or a facet of a person's\n\t\t\t\t\t\tphysical being, that enables an individual access to a given physical facility or computer-based\n\t\t\t\t\t\tinformation system. A credential holds one or more credential identifiers. To gain access one or\n\t\t\t\t\t\tmore identifiers may be required.", + "base": "{http://www.onvif.org/ver10/credential/wsdl}CredentialInfo", + "base_definition": { + "kind": "complexType", + "name": "CredentialInfo", + "description": "The CredentialInfo type represents the credential as a logical object. The structure contains\n\t\t\t\t\t\tthe basic information of a specific credential instance. The device shall provide the following\n\t\t\t\t\t\tfields for each credential.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the credential. It shall be up to 1024 characters." + }, + { + "name": "CredentialHolderReference", + "definition": { + "kind": "simpleType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "An external reference to a person holding this credential. The\n\t\t\t\t\t\t\t\t\t\treference is a username or used ID in an external system, such as a directory\n\t\t\t\t\t\t\t\t\t\tservice." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The expiration date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "CredentialIdentifier", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifier", + "type_name": "CredentialIdentifier", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifier", + "description": "A credential identifier is a card number, unique card information, PIN or\n\t\t\t\t\t\tbiometric information such as fingerprint, iris, vein, face recognition, that can be validated\n\t\t\t\t\t\tin an access point.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierType", + "type_name": "CredentialIdentifierType", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierType", + "description": "Specifies the name of credential identifier type and its format for the credential\n\t\t\t\t\t\tvalue.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the credential identifier type, such as pt:Card, pt:PIN,\n\t\t\t\t\t\t\t\tetc." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the format of the credential value for the specified identifier\n\t\t\t\t\t\t\t\ttype name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the details of the credential identifier type. Is of type\n\t\t\t\t\t\t\t\tCredentialIdentifierType." + }, + { + "name": "ExemptedFromAuthentication", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If set to true, this credential identifier is not considered for \n authentication. For example if the access point requests Card plus PIN, and the credential \n identifier of type PIN is exempted from authentication, then the access point will not prompt \n for the PIN." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the identifier in hexadecimal representation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential identifier structures. At least one\n\t\t\t\t\t\t\t\t\t\tcredential identifier is required. Maximum one credential identifier structure\n\t\t\t\t\t\t\t\t\t\tper type is allowed." + }, + { + "name": "CredentialAccessProfile", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialAccessProfile", + "type_name": "CredentialAccessProfile", + "definition": { + "kind": "complexType", + "name": "CredentialAccessProfile", + "description": "The association between a credential and an access profile.", + "fields": [ + { + "name": "AccessProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The reference token of the associated access profile." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The end date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential access profile structures." + }, + { + "name": "ExtendedGrantTime", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A boolean indicating that the credential holder needs extra time to get through the door. \n\t\t\t\t\t\t\t\t\t\tExtendedReleaseTime will be added to ReleaseTime, and ExtendedOpenTime will be added to OpenTime", + "default": "false" + }, + { + "name": "Attribute", + "type": "{http://www.onvif.org/ver10/pacs}Attribute", + "type_name": "Attribute", + "definition": { + "kind": "complexType", + "name": "Attribute", + "description": "Attributes contains a Name and an optional Value and type.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of attribute. Key names starting with \"ONVIF\" (any case) are reserved for ONVIF\n\t\t\t\t\tuse." + }, + { + "use": "optional", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Value of attribute." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential attributes as name value pairs. Key names\n\t\t\t\t\t\t\t\t\t\tstarting with the prefix pt: are reserved to define PACS specific attributes\n\t\t\t\t\t\t\t\t\t\tfollowing the \"pt:<Name>\" syntax." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialExtension", + "type_name": "CredentialExtension", + "definition": { + "kind": "complexType", + "name": "CredentialExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of Credential items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "CreateCredential", + "port_type": "CredentialPort", + "description": "This operation creates a credential. A call to this method takes a credential structure and a credential state structure as input parameters. The credential state can be created in disabled or enabled state. The token field of the credential shall be empty, the device shall allocate a token for the credential. The allocated token shall be returned in the response. If the client sends any value in the token field, the device shall return InvalidArgVal as generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}CreateCredentialRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}CreateCredential", + "schema": { + "name": "CreateCredential", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Credential", + "type": "{http://www.onvif.org/ver10/credential/wsdl}Credential", + "type_name": "Credential", + "definition": { + "kind": "complexType", + "name": "Credential", + "description": "A Credential is a physical/tangible object, a piece of knowledge, or a facet of a person's\n\t\t\t\t\t\tphysical being, that enables an individual access to a given physical facility or computer-based\n\t\t\t\t\t\tinformation system. A credential holds one or more credential identifiers. To gain access one or\n\t\t\t\t\t\tmore identifiers may be required.", + "base": "{http://www.onvif.org/ver10/credential/wsdl}CredentialInfo", + "base_definition": { + "kind": "complexType", + "name": "CredentialInfo", + "description": "The CredentialInfo type represents the credential as a logical object. The structure contains\n\t\t\t\t\t\tthe basic information of a specific credential instance. The device shall provide the following\n\t\t\t\t\t\tfields for each credential.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the credential. It shall be up to 1024 characters." + }, + { + "name": "CredentialHolderReference", + "definition": { + "kind": "simpleType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "An external reference to a person holding this credential. The\n\t\t\t\t\t\t\t\t\t\treference is a username or used ID in an external system, such as a directory\n\t\t\t\t\t\t\t\t\t\tservice." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The expiration date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "CredentialIdentifier", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifier", + "type_name": "CredentialIdentifier", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifier", + "description": "A credential identifier is a card number, unique card information, PIN or\n\t\t\t\t\t\tbiometric information such as fingerprint, iris, vein, face recognition, that can be validated\n\t\t\t\t\t\tin an access point.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierType", + "type_name": "CredentialIdentifierType", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierType", + "description": "Specifies the name of credential identifier type and its format for the credential\n\t\t\t\t\t\tvalue.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the credential identifier type, such as pt:Card, pt:PIN,\n\t\t\t\t\t\t\t\tetc." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the format of the credential value for the specified identifier\n\t\t\t\t\t\t\t\ttype name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the details of the credential identifier type. Is of type\n\t\t\t\t\t\t\t\tCredentialIdentifierType." + }, + { + "name": "ExemptedFromAuthentication", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If set to true, this credential identifier is not considered for \n authentication. For example if the access point requests Card plus PIN, and the credential \n identifier of type PIN is exempted from authentication, then the access point will not prompt \n for the PIN." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the identifier in hexadecimal representation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential identifier structures. At least one\n\t\t\t\t\t\t\t\t\t\tcredential identifier is required. Maximum one credential identifier structure\n\t\t\t\t\t\t\t\t\t\tper type is allowed." + }, + { + "name": "CredentialAccessProfile", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialAccessProfile", + "type_name": "CredentialAccessProfile", + "definition": { + "kind": "complexType", + "name": "CredentialAccessProfile", + "description": "The association between a credential and an access profile.", + "fields": [ + { + "name": "AccessProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The reference token of the associated access profile." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The end date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential access profile structures." + }, + { + "name": "ExtendedGrantTime", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A boolean indicating that the credential holder needs extra time to get through the door. \n\t\t\t\t\t\t\t\t\t\tExtendedReleaseTime will be added to ReleaseTime, and ExtendedOpenTime will be added to OpenTime", + "default": "false" + }, + { + "name": "Attribute", + "type": "{http://www.onvif.org/ver10/pacs}Attribute", + "type_name": "Attribute", + "definition": { + "kind": "complexType", + "name": "Attribute", + "description": "Attributes contains a Name and an optional Value and type.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of attribute. Key names starting with \"ONVIF\" (any case) are reserved for ONVIF\n\t\t\t\t\tuse." + }, + { + "use": "optional", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Value of attribute." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential attributes as name value pairs. Key names\n\t\t\t\t\t\t\t\t\t\tstarting with the prefix pt: are reserved to define PACS specific attributes\n\t\t\t\t\t\t\t\t\t\tfollowing the \"pt:<Name>\" syntax." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialExtension", + "type_name": "CredentialExtension", + "definition": { + "kind": "complexType", + "name": "CredentialExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The credential to create." + }, + { + "name": "State", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialState", + "type_name": "CredentialState", + "definition": { + "kind": "complexType", + "name": "CredentialState", + "description": "The CredentialState structure contains information about the state of the credential and\n\t\t\t\t\t\toptionally the reason of why the credential was disabled.", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the credential is enabled or false if the credential is\n\t\t\t\t\t\t\t\tdisabled." + }, + { + "name": "Reason", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Predefined ONVIF reasons as mentioned in the section 5.4.2.7 \n\t\t\t\t\t\t\t\tof credential service specification document. For any other reason, free\n\t\t\t\t\t\t\t\ttext can be used." + }, + { + "name": "AntipassbackState", + "type": "{http://www.onvif.org/ver10/credential/wsdl}AntipassbackState", + "type_name": "AntipassbackState", + "definition": { + "kind": "complexType", + "name": "AntipassbackState", + "description": "A structure containing anti-passback related state information.", + "fields": [ + { + "name": "AntipassbackViolated", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if anti-passback is violated for the credential." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A structure indicating the anti-passback state. This field shall be\n\t\t\t\t\t\t\t\tsupported if the ResetAntipassbackSupported capability is set to true." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialStateExtension", + "type_name": "CredentialStateExtension", + "definition": { + "kind": "complexType", + "name": "CredentialStateExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The state of the credential." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}CreateCredentialResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}CreateCredentialResponse", + "schema": { + "name": "CreateCredentialResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the created credential" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "SetCredential", + "port_type": "CredentialPort", + "description": "This method is used to synchronize a credential in a client with the device.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}SetCredentialRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}SetCredential", + "schema": { + "name": "SetCredential", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CredentialData", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialData", + "type_name": "CredentialData", + "definition": { + "kind": "complexType", + "name": "CredentialData", + "description": "Contains information about a format type.", + "fields": [ + { + "name": "Credential", + "type": "{http://www.onvif.org/ver10/credential/wsdl}Credential", + "type_name": "Credential", + "definition": { + "kind": "complexType", + "name": "Credential", + "description": "A Credential is a physical/tangible object, a piece of knowledge, or a facet of a person's\n\t\t\t\t\t\tphysical being, that enables an individual access to a given physical facility or computer-based\n\t\t\t\t\t\tinformation system. A credential holds one or more credential identifiers. To gain access one or\n\t\t\t\t\t\tmore identifiers may be required.", + "base": "{http://www.onvif.org/ver10/credential/wsdl}CredentialInfo", + "base_definition": { + "kind": "complexType", + "name": "CredentialInfo", + "description": "The CredentialInfo type represents the credential as a logical object. The structure contains\n\t\t\t\t\t\tthe basic information of a specific credential instance. The device shall provide the following\n\t\t\t\t\t\tfields for each credential.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the credential. It shall be up to 1024 characters." + }, + { + "name": "CredentialHolderReference", + "definition": { + "kind": "simpleType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "An external reference to a person holding this credential. The\n\t\t\t\t\t\t\t\t\t\treference is a username or used ID in an external system, such as a directory\n\t\t\t\t\t\t\t\t\t\tservice." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The expiration date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "CredentialIdentifier", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifier", + "type_name": "CredentialIdentifier", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifier", + "description": "A credential identifier is a card number, unique card information, PIN or\n\t\t\t\t\t\tbiometric information such as fingerprint, iris, vein, face recognition, that can be validated\n\t\t\t\t\t\tin an access point.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierType", + "type_name": "CredentialIdentifierType", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierType", + "description": "Specifies the name of credential identifier type and its format for the credential\n\t\t\t\t\t\tvalue.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the credential identifier type, such as pt:Card, pt:PIN,\n\t\t\t\t\t\t\t\tetc." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the format of the credential value for the specified identifier\n\t\t\t\t\t\t\t\ttype name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the details of the credential identifier type. Is of type\n\t\t\t\t\t\t\t\tCredentialIdentifierType." + }, + { + "name": "ExemptedFromAuthentication", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If set to true, this credential identifier is not considered for \n authentication. For example if the access point requests Card plus PIN, and the credential \n identifier of type PIN is exempted from authentication, then the access point will not prompt \n for the PIN." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the identifier in hexadecimal representation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential identifier structures. At least one\n\t\t\t\t\t\t\t\t\t\tcredential identifier is required. Maximum one credential identifier structure\n\t\t\t\t\t\t\t\t\t\tper type is allowed." + }, + { + "name": "CredentialAccessProfile", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialAccessProfile", + "type_name": "CredentialAccessProfile", + "definition": { + "kind": "complexType", + "name": "CredentialAccessProfile", + "description": "The association between a credential and an access profile.", + "fields": [ + { + "name": "AccessProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The reference token of the associated access profile." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The end date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential access profile structures." + }, + { + "name": "ExtendedGrantTime", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A boolean indicating that the credential holder needs extra time to get through the door. \n\t\t\t\t\t\t\t\t\t\tExtendedReleaseTime will be added to ReleaseTime, and ExtendedOpenTime will be added to OpenTime", + "default": "false" + }, + { + "name": "Attribute", + "type": "{http://www.onvif.org/ver10/pacs}Attribute", + "type_name": "Attribute", + "definition": { + "kind": "complexType", + "name": "Attribute", + "description": "Attributes contains a Name and an optional Value and type.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of attribute. Key names starting with \"ONVIF\" (any case) are reserved for ONVIF\n\t\t\t\t\tuse." + }, + { + "use": "optional", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Value of attribute." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential attributes as name value pairs. Key names\n\t\t\t\t\t\t\t\t\t\tstarting with the prefix pt: are reserved to define PACS specific attributes\n\t\t\t\t\t\t\t\t\t\tfollowing the \"pt:<Name>\" syntax." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialExtension", + "type_name": "CredentialExtension", + "definition": { + "kind": "complexType", + "name": "CredentialExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A format type supported by the device. A list of supported format types is\n\t\t\t\t\t\t\t\tprovided in [ISO 16484-5:2014-09 Annex P]. The BACnet type \"CUSTOM\" is not used in this\n\t\t\t\t\t\t\t\tspecification. Instead device manufacturers can define their own format types." + }, + { + "name": "CredentialState", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialState", + "type_name": "CredentialState", + "definition": { + "kind": "complexType", + "name": "CredentialState", + "description": "The CredentialState structure contains information about the state of the credential and\n\t\t\t\t\t\toptionally the reason of why the credential was disabled.", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the credential is enabled or false if the credential is\n\t\t\t\t\t\t\t\tdisabled." + }, + { + "name": "Reason", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Predefined ONVIF reasons as mentioned in the section 5.4.2.7 \n\t\t\t\t\t\t\t\tof credential service specification document. For any other reason, free\n\t\t\t\t\t\t\t\ttext can be used." + }, + { + "name": "AntipassbackState", + "type": "{http://www.onvif.org/ver10/credential/wsdl}AntipassbackState", + "type_name": "AntipassbackState", + "definition": { + "kind": "complexType", + "name": "AntipassbackState", + "description": "A structure containing anti-passback related state information.", + "fields": [ + { + "name": "AntipassbackViolated", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if anti-passback is violated for the credential." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A structure indicating the anti-passback state. This field shall be\n\t\t\t\t\t\t\t\tsupported if the ResetAntipassbackSupported capability is set to true." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialStateExtension", + "type_name": "CredentialStateExtension", + "definition": { + "kind": "complexType", + "name": "CredentialStateExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable description of the credential identifier format type. It\n\t\t\t\t\t\t\t\tshall be up to 1024 characters. For custom types, it is recommended to describe how the\n\t\t\t\t\t\t\t\toctet string is encoded (following the structure in column Authentication Factor Value\n\t\t\t\t\t\t\t\tEncoding of [ISO 16484-5:2014-09 Annex P])." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialDataExtension", + "type_name": "CredentialDataExtension", + "definition": { + "kind": "complexType", + "name": "CredentialDataExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Details of the credential." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}SetCredentialResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}SetCredentialResponse", + "schema": { + "name": "SetCredentialResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "ModifyCredential", + "port_type": "CredentialPort", + "description": "This operation modifies the specified credential. The token of the credential to modify is specified in the token field of the Credential structure and shall not be empty. All other fields in the structure shall overwrite the fields in the specified credential. When an existing credential is modified, the state is not modified explicitly. The only way for a client to change the state of a credential is to explicitly call the EnableCredential, DisableCredential or ResetAntipassback command. All existing credential identifiers and credential access profiles are removed and replaced with the specified entities.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}ModifyCredentialRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}ModifyCredential", + "schema": { + "name": "ModifyCredential", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Credential", + "type": "{http://www.onvif.org/ver10/credential/wsdl}Credential", + "type_name": "Credential", + "definition": { + "kind": "complexType", + "name": "Credential", + "description": "A Credential is a physical/tangible object, a piece of knowledge, or a facet of a person's\n\t\t\t\t\t\tphysical being, that enables an individual access to a given physical facility or computer-based\n\t\t\t\t\t\tinformation system. A credential holds one or more credential identifiers. To gain access one or\n\t\t\t\t\t\tmore identifiers may be required.", + "base": "{http://www.onvif.org/ver10/credential/wsdl}CredentialInfo", + "base_definition": { + "kind": "complexType", + "name": "CredentialInfo", + "description": "The CredentialInfo type represents the credential as a logical object. The structure contains\n\t\t\t\t\t\tthe basic information of a specific credential instance. The device shall provide the following\n\t\t\t\t\t\tfields for each credential.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the credential. It shall be up to 1024 characters." + }, + { + "name": "CredentialHolderReference", + "definition": { + "kind": "simpleType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "An external reference to a person holding this credential. The\n\t\t\t\t\t\t\t\t\t\treference is a username or used ID in an external system, such as a directory\n\t\t\t\t\t\t\t\t\t\tservice." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The expiration date/time validity of the credential. If the\n\t\t\t\t\t\t\t\t\t\tValiditySupportsTimeValue capability is set to false, then only date is\n\t\t\t\t\t\t\t\t\t\tsupported (time is ignored)." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "CredentialIdentifier", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifier", + "type_name": "CredentialIdentifier", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifier", + "description": "A credential identifier is a card number, unique card information, PIN or\n\t\t\t\t\t\tbiometric information such as fingerprint, iris, vein, face recognition, that can be validated\n\t\t\t\t\t\tin an access point.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierType", + "type_name": "CredentialIdentifierType", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierType", + "description": "Specifies the name of credential identifier type and its format for the credential\n\t\t\t\t\t\tvalue.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the credential identifier type, such as pt:Card, pt:PIN,\n\t\t\t\t\t\t\t\tetc." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the format of the credential value for the specified identifier\n\t\t\t\t\t\t\t\ttype name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the details of the credential identifier type. Is of type\n\t\t\t\t\t\t\t\tCredentialIdentifierType." + }, + { + "name": "ExemptedFromAuthentication", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If set to true, this credential identifier is not considered for \n authentication. For example if the access point requests Card plus PIN, and the credential \n identifier of type PIN is exempted from authentication, then the access point will not prompt \n for the PIN." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the identifier in hexadecimal representation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential identifier structures. At least one\n\t\t\t\t\t\t\t\t\t\tcredential identifier is required. Maximum one credential identifier structure\n\t\t\t\t\t\t\t\t\t\tper type is allowed." + }, + { + "name": "CredentialAccessProfile", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialAccessProfile", + "type_name": "CredentialAccessProfile", + "definition": { + "kind": "complexType", + "name": "CredentialAccessProfile", + "description": "The association between a credential and an access profile.", + "fields": [ + { + "name": "AccessProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The reference token of the associated access profile." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The end date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential access profile structures." + }, + { + "name": "ExtendedGrantTime", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A boolean indicating that the credential holder needs extra time to get through the door. \n\t\t\t\t\t\t\t\t\t\tExtendedReleaseTime will be added to ReleaseTime, and ExtendedOpenTime will be added to OpenTime", + "default": "false" + }, + { + "name": "Attribute", + "type": "{http://www.onvif.org/ver10/pacs}Attribute", + "type_name": "Attribute", + "definition": { + "kind": "complexType", + "name": "Attribute", + "description": "Attributes contains a Name and an optional Value and type.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of attribute. Key names starting with \"ONVIF\" (any case) are reserved for ONVIF\n\t\t\t\t\tuse." + }, + { + "use": "optional", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Value of attribute." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of credential attributes as name value pairs. Key names\n\t\t\t\t\t\t\t\t\t\tstarting with the prefix pt: are reserved to define PACS specific attributes\n\t\t\t\t\t\t\t\t\t\tfollowing the \"pt:<Name>\" syntax." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialExtension", + "type_name": "CredentialExtension", + "definition": { + "kind": "complexType", + "name": "CredentialExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Details of the credential." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}ModifyCredentialResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}ModifyCredentialResponse", + "schema": { + "name": "ModifyCredentialResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "DeleteCredential", + "port_type": "CredentialPort", + "description": "This method deletes the specified credential. If it is associated with one or more entities some devices may not be able to delete the credential, and consequently a ReferenceInUse fault shall be generated.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}DeleteCredentialRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}DeleteCredential", + "schema": { + "name": "DeleteCredential", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the credential to delete." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}DeleteCredentialResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}DeleteCredentialResponse", + "schema": { + "name": "DeleteCredentialResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "GetCredentialState", + "port_type": "CredentialPort", + "description": "This method returns the state for the specified credential. If the capability ResetAntipassbackSupported is set to true, then the device shall supply the anti-passback state in the returned credential state structure.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialStateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialState", + "schema": { + "name": "GetCredentialState", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of Credential" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialStateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialStateResponse", + "schema": { + "name": "GetCredentialStateResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "State", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialState", + "type_name": "CredentialState", + "definition": { + "kind": "complexType", + "name": "CredentialState", + "description": "The CredentialState structure contains information about the state of the credential and\n\t\t\t\t\t\toptionally the reason of why the credential was disabled.", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the credential is enabled or false if the credential is\n\t\t\t\t\t\t\t\tdisabled." + }, + { + "name": "Reason", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Predefined ONVIF reasons as mentioned in the section 5.4.2.7 \n\t\t\t\t\t\t\t\tof credential service specification document. For any other reason, free\n\t\t\t\t\t\t\t\ttext can be used." + }, + { + "name": "AntipassbackState", + "type": "{http://www.onvif.org/ver10/credential/wsdl}AntipassbackState", + "type_name": "AntipassbackState", + "definition": { + "kind": "complexType", + "name": "AntipassbackState", + "description": "A structure containing anti-passback related state information.", + "fields": [ + { + "name": "AntipassbackViolated", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if anti-passback is violated for the credential." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A structure indicating the anti-passback state. This field shall be\n\t\t\t\t\t\t\t\tsupported if the ResetAntipassbackSupported capability is set to true." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialStateExtension", + "type_name": "CredentialStateExtension", + "definition": { + "kind": "complexType", + "name": "CredentialStateExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "State of the credential." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "EnableCredential", + "port_type": "CredentialPort", + "description": "This method is used to enable a credential.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}EnableCredentialRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}EnableCredential", + "schema": { + "name": "EnableCredential", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the credential" + }, + { + "name": "Reason", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Reason for enabling the credential." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}EnableCredentialResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}EnableCredentialResponse", + "schema": { + "name": "EnableCredentialResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "DisableCredential", + "port_type": "CredentialPort", + "description": "This method is used to disable a credential.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}DisableCredentialRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}DisableCredential", + "schema": { + "name": "DisableCredential", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Credential" + }, + { + "name": "Reason", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Reason for disabling the credential" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}DisableCredentialResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}DisableCredentialResponse", + "schema": { + "name": "DisableCredentialResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "ResetAntipassbackViolation", + "port_type": "CredentialPort", + "description": "This method is used to reset anti-passback violations for a specified credential.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}ResetAntipassbackViolationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}ResetAntipassbackViolation", + "schema": { + "name": "ResetAntipassbackViolation", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CredentialToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Credential" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}ResetAntipassbackViolationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}ResetAntipassbackViolationResponse", + "schema": { + "name": "ResetAntipassbackViolationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "GetCredentialIdentifiers", + "port_type": "CredentialPort", + "description": "This method returns all the credential identifiers for a credential.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialIdentifiersRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialIdentifiers", + "schema": { + "name": "GetCredentialIdentifiers", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CredentialToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Credential" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialIdentifiersResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialIdentifiersResponse", + "schema": { + "name": "GetCredentialIdentifiersResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CredentialIdentifier", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifier", + "type_name": "CredentialIdentifier", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifier", + "description": "A credential identifier is a card number, unique card information, PIN or\n\t\t\t\t\t\tbiometric information such as fingerprint, iris, vein, face recognition, that can be validated\n\t\t\t\t\t\tin an access point.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierType", + "type_name": "CredentialIdentifierType", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierType", + "description": "Specifies the name of credential identifier type and its format for the credential\n\t\t\t\t\t\tvalue.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the credential identifier type, such as pt:Card, pt:PIN,\n\t\t\t\t\t\t\t\tetc." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the format of the credential value for the specified identifier\n\t\t\t\t\t\t\t\ttype name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the details of the credential identifier type. Is of type\n\t\t\t\t\t\t\t\tCredentialIdentifierType." + }, + { + "name": "ExemptedFromAuthentication", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If set to true, this credential identifier is not considered for \n authentication. For example if the access point requests Card plus PIN, and the credential \n identifier of type PIN is exempted from authentication, then the access point will not prompt \n for the PIN." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the identifier in hexadecimal representation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Identifier of the credential" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "SetCredentialIdentifier", + "port_type": "CredentialPort", + "description": "This operation creates or updates a credential identifier for a credential. If the type of specified credential identifier already exists, the current credential identifier of that type is replaced. Otherwise the credential identifier is added.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}SetCredentialIdentifierRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}SetCredentialIdentifier", + "schema": { + "name": "SetCredentialIdentifier", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CredentialToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Credential" + }, + { + "name": "CredentialIdentifier", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifier", + "type_name": "CredentialIdentifier", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifier", + "description": "A credential identifier is a card number, unique card information, PIN or\n\t\t\t\t\t\tbiometric information such as fingerprint, iris, vein, face recognition, that can be validated\n\t\t\t\t\t\tin an access point.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierType", + "type_name": "CredentialIdentifierType", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierType", + "description": "Specifies the name of credential identifier type and its format for the credential\n\t\t\t\t\t\tvalue.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the credential identifier type, such as pt:Card, pt:PIN,\n\t\t\t\t\t\t\t\tetc." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the format of the credential value for the specified identifier\n\t\t\t\t\t\t\t\ttype name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the details of the credential identifier type. Is of type\n\t\t\t\t\t\t\t\tCredentialIdentifierType." + }, + { + "name": "ExemptedFromAuthentication", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If set to true, this credential identifier is not considered for \n authentication. For example if the access point requests Card plus PIN, and the credential \n identifier of type PIN is exempted from authentication, then the access point will not prompt \n for the PIN." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the identifier in hexadecimal representation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifier of the credential" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}SetCredentialIdentifierResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}SetCredentialIdentifierResponse", + "schema": { + "name": "SetCredentialIdentifierResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "DeleteCredentialIdentifier", + "port_type": "CredentialPort", + "description": "This method deletes all the identifier values for the specified type. However, if the identifier type name doesn’t exist in the device, it will be silently ignored without any response.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}DeleteCredentialIdentifierRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}DeleteCredentialIdentifier", + "schema": { + "name": "DeleteCredentialIdentifier", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CredentialToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Credential" + }, + { + "name": "CredentialIdentifierTypeName", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifier type name of a credential" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}DeleteCredentialIdentifierResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}DeleteCredentialIdentifierResponse", + "schema": { + "name": "DeleteCredentialIdentifierResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "GetCredentialAccessProfiles", + "port_type": "CredentialPort", + "description": "This method returns all the credential access profiles for a credential.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialAccessProfilesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialAccessProfiles", + "schema": { + "name": "GetCredentialAccessProfiles", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CredentialToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Credential" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialAccessProfilesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetCredentialAccessProfilesResponse", + "schema": { + "name": "GetCredentialAccessProfilesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CredentialAccessProfile", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialAccessProfile", + "type_name": "CredentialAccessProfile", + "definition": { + "kind": "complexType", + "name": "CredentialAccessProfile", + "description": "The association between a credential and an access profile.", + "fields": [ + { + "name": "AccessProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The reference token of the associated access profile." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The end date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Access Profiles of the credential" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "SetCredentialAccessProfiles", + "port_type": "CredentialPort", + "description": "This operation add or updates the credential access profiles for a credential. The device shall update the credential access profile if the access profile token in the specified credential access profile matches. Otherwise the credential access profile is added.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}SetCredentialAccessProfilesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}SetCredentialAccessProfiles", + "schema": { + "name": "SetCredentialAccessProfiles", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CredentialToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Credential" + }, + { + "name": "CredentialAccessProfile", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialAccessProfile", + "type_name": "CredentialAccessProfile", + "definition": { + "kind": "complexType", + "name": "CredentialAccessProfile", + "description": "The association between a credential and an access profile.", + "fields": [ + { + "name": "AccessProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The reference token of the associated access profile." + }, + { + "name": "ValidFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The start date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + }, + { + "name": "ValidTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The end date/time of the validity for the association between the\n\t\t\t\t\t\t\t\tcredential and the access profile. If the ValiditySupportsTimeValue capability is set to\n\t\t\t\t\t\t\t\tfalse, then only date is supported (time is ignored)." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Access Profiles of the credential" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}SetCredentialAccessProfilesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}SetCredentialAccessProfilesResponse", + "schema": { + "name": "SetCredentialAccessProfilesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "DeleteCredentialAccessProfiles", + "port_type": "CredentialPort", + "description": "This method deletes all the credential access profiles for the specified tokens. However, if no matching credential access profiles are found, the corresponding access profile tokens are silently ignored without any response.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}DeleteCredentialAccessProfilesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}DeleteCredentialAccessProfiles", + "schema": { + "name": "DeleteCredentialAccessProfiles", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CredentialToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Credential" + }, + { + "name": "AccessProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of Access Profiles" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}DeleteCredentialAccessProfilesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}DeleteCredentialAccessProfilesResponse", + "schema": { + "name": "DeleteCredentialAccessProfilesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "GetWhitelist", + "port_type": "CredentialPort", + "description": "This command requests a list of all whitelisted credential identifiers in the device. A device with capability MaxWhitelistedItems greater than zero, shall implement this command.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetWhitelistRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetWhitelist", + "schema": { + "name": "GetWhitelist", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one or higher than what the device\n supports, the number of items is determined by the device." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified, entries shall start from the\n beginning of the dataset." + }, + { + "name": "IdentifierType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Get only whitelisted credential identifiers with the specified identifier type." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Get only whitelisted credential identifiers with the specified identifier format type." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Get only whitelisted credential identifiers with the specified identifier value." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetWhitelistResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetWhitelistResponse", + "schema": { + "name": "GetWhitelistResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If absent, no more items to get." + }, + { + "name": "Identifier", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierItem", + "type_name": "CredentialIdentifierItem", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierItem", + "description": "A credential identifier is a card number, unique card information, PIN or biometric information\n such as fingerprint, iris, vein, face recognition, that can be validated in an access point.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierType", + "type_name": "CredentialIdentifierType", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierType", + "description": "Specifies the name of credential identifier type and its format for the credential\n\t\t\t\t\t\tvalue.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the credential identifier type, such as pt:Card, pt:PIN,\n\t\t\t\t\t\t\t\tetc." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the format of the credential value for the specified identifier\n\t\t\t\t\t\t\t\ttype name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the details of the credential identifier type." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the identifier in hexadecimal representation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The whitelisted credential identifiers matching the request criteria." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "AddToWhitelist", + "port_type": "CredentialPort", + "description": "This command adds the specified credential identifiers to the whitelist. A device with capability MaxWhitelistedItems greater than zero, shall implement this command. If a specified whitelist item also is blacklisted, the item shall be removed from the blacklist.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}AddToWhitelistRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}AddToWhitelist", + "schema": { + "name": "AddToWhitelist", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Identifier", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierItem", + "type_name": "CredentialIdentifierItem", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierItem", + "description": "A credential identifier is a card number, unique card information, PIN or biometric information\n such as fingerprint, iris, vein, face recognition, that can be validated in an access point.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierType", + "type_name": "CredentialIdentifierType", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierType", + "description": "Specifies the name of credential identifier type and its format for the credential\n\t\t\t\t\t\tvalue.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the credential identifier type, such as pt:Card, pt:PIN,\n\t\t\t\t\t\t\t\tetc." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the format of the credential value for the specified identifier\n\t\t\t\t\t\t\t\ttype name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the details of the credential identifier type." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the identifier in hexadecimal representation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "The credential identifiers to be added to the whitelist." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}AddToWhitelistResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}AddToWhitelistResponse", + "schema": { + "name": "AddToWhitelistResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "RemoveFromWhitelist", + "port_type": "CredentialPort", + "description": "This command removes the specified credential identifiers from the whitelist. A device with capability MaxWhitelistedItems greater than zero, shall implement this command. This command is idempotent and is safe to repeat even if the specified whitelist items do not exist.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}RemoveFromWhitelistRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}RemoveFromWhitelist", + "schema": { + "name": "RemoveFromWhitelist", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Identifier", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierItem", + "type_name": "CredentialIdentifierItem", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierItem", + "description": "A credential identifier is a card number, unique card information, PIN or biometric information\n such as fingerprint, iris, vein, face recognition, that can be validated in an access point.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierType", + "type_name": "CredentialIdentifierType", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierType", + "description": "Specifies the name of credential identifier type and its format for the credential\n\t\t\t\t\t\tvalue.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the credential identifier type, such as pt:Card, pt:PIN,\n\t\t\t\t\t\t\t\tetc." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the format of the credential value for the specified identifier\n\t\t\t\t\t\t\t\ttype name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the details of the credential identifier type." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the identifier in hexadecimal representation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "The credential identifiers to be removed from the whitelist." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}RemoveFromWhitelistResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}RemoveFromWhitelistResponse", + "schema": { + "name": "RemoveFromWhitelistResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "DeleteWhitelist", + "port_type": "CredentialPort", + "description": "This command deletes all credential identifiers from the whitelist. A device with capability MaxWhitelistedItems greater than zero, shall implement this command. This command is idempotent and is safe to repeat even if the whitelist already is empty.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}DeleteWhitelistRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}DeleteWhitelist", + "schema": { + "name": "DeleteWhitelist", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}DeleteWhitelistResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}DeleteWhitelistResponse", + "schema": { + "name": "DeleteWhitelistResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "GetBlacklist", + "port_type": "CredentialPort", + "description": "This command requests a list of all blacklisted credential identifiers in the device. A device with capability MaxBlacklistedItems greater than zero, shall implement this command.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetBlacklistRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetBlacklist", + "schema": { + "name": "GetBlacklist", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one or higher than what the device\n supports, the number of items is determined by the device." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified, entries shall start from the\n beginning of the dataset." + }, + { + "name": "IdentifierType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Get only blacklisted credential identifiers with the specified identifier type." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Get only blacklisted credential identifiers with the specified identifier format type." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Get only blacklisted credential identifiers with the specified identifier value." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}GetBlacklistResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}GetBlacklistResponse", + "schema": { + "name": "GetBlacklistResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If absent, no more items to get." + }, + { + "name": "Identifier", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierItem", + "type_name": "CredentialIdentifierItem", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierItem", + "description": "A credential identifier is a card number, unique card information, PIN or biometric information\n such as fingerprint, iris, vein, face recognition, that can be validated in an access point.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierType", + "type_name": "CredentialIdentifierType", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierType", + "description": "Specifies the name of credential identifier type and its format for the credential\n\t\t\t\t\t\tvalue.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the credential identifier type, such as pt:Card, pt:PIN,\n\t\t\t\t\t\t\t\tetc." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the format of the credential value for the specified identifier\n\t\t\t\t\t\t\t\ttype name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the details of the credential identifier type." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the identifier in hexadecimal representation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The blacklisted credential identifiers matching the request criteria." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "AddToBlacklist", + "port_type": "CredentialPort", + "description": "This command adds the specified credential identifiers to the blacklist. A device with capability MaxBlacklistedItems greater than zero, shall implement this command. If a specified blacklist item also is whitelisted, the item shall be removed from the whitelist.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}AddToBlacklistRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}AddToBlacklist", + "schema": { + "name": "AddToBlacklist", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Identifier", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierItem", + "type_name": "CredentialIdentifierItem", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierItem", + "description": "A credential identifier is a card number, unique card information, PIN or biometric information\n such as fingerprint, iris, vein, face recognition, that can be validated in an access point.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierType", + "type_name": "CredentialIdentifierType", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierType", + "description": "Specifies the name of credential identifier type and its format for the credential\n\t\t\t\t\t\tvalue.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the credential identifier type, such as pt:Card, pt:PIN,\n\t\t\t\t\t\t\t\tetc." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the format of the credential value for the specified identifier\n\t\t\t\t\t\t\t\ttype name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the details of the credential identifier type." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the identifier in hexadecimal representation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "The credential identifiers to be added to the blacklist." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}AddToBlacklistResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}AddToBlacklistResponse", + "schema": { + "name": "AddToBlacklistResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "RemoveFromBlacklist", + "port_type": "CredentialPort", + "description": "This command removes the specified credential identifiers from the blacklist. A device with capability MaxBlacklistedItems greater than zero, shall implement this command. This command is idempotent and is safe to repeat even if the specified blacklist items do not exist.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}RemoveFromBlacklistRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}RemoveFromBlacklist", + "schema": { + "name": "RemoveFromBlacklist", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Identifier", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierItem", + "type_name": "CredentialIdentifierItem", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierItem", + "description": "A credential identifier is a card number, unique card information, PIN or biometric information\n such as fingerprint, iris, vein, face recognition, that can be validated in an access point.", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/credential/wsdl}CredentialIdentifierType", + "type_name": "CredentialIdentifierType", + "definition": { + "kind": "complexType", + "name": "CredentialIdentifierType", + "description": "Specifies the name of credential identifier type and its format for the credential\n\t\t\t\t\t\tvalue.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The name of the credential identifier type, such as pt:Card, pt:PIN,\n\t\t\t\t\t\t\t\tetc." + }, + { + "name": "FormatType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the format of the credential value for the specified identifier\n\t\t\t\t\t\t\t\ttype name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the details of the credential identifier type." + }, + { + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The value of the identifier in hexadecimal representation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "The credential identifiers to be removed from the blacklist." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}RemoveFromBlacklistResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}RemoveFromBlacklistResponse", + "schema": { + "name": "RemoveFromBlacklistResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + }, + { + "name": "DeleteBlacklist", + "port_type": "CredentialPort", + "description": "This command deletes all credential identifiers from the blacklist. A device with capability MaxBlacklistedItems greater than zero, shall implement this command. This command is idempotent and is safe to repeat even if the blacklist already is empty.", + "input": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}DeleteBlacklistRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}DeleteBlacklist", + "schema": { + "name": "DeleteBlacklist", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/credential/wsdl}DeleteBlacklistResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/credential/wsdl}DeleteBlacklistResponse", + "schema": { + "name": "DeleteBlacklistResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "CredentialBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/device/wsdl/devicemgmt.json b/docs/generated/wsdl/ver10/device/wsdl/devicemgmt.json new file mode 100644 index 00000000..bb592176 --- /dev/null +++ b/docs/generated/wsdl/ver10/device/wsdl/devicemgmt.json @@ -0,0 +1,16209 @@ +{ + "source": "ver10/device/wsdl/devicemgmt.wsdl", + "target_namespace": "http://www.onvif.org/ver10/device/wsdl", + "operations": [ + { + "name": "GetServices", + "port_type": "Device", + "description": "Returns information about services on the device.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetServicesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetServices", + "schema": { + "name": "GetServices", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "IncludeCapability", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the service capabilities (untyped) should be included in the response." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetServicesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetServicesResponse", + "schema": { + "name": "GetServicesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Service", + "type": "{http://www.onvif.org/ver10/device/wsdl}Service", + "type_name": "Service", + "definition": { + "kind": "complexType", + "name": "Service", + "fields": [ + { + "name": "Namespace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Namespace of the service being described. This parameter allows to match the service capabilities to the service. Note that only one set of capabilities is supported per namespace." + }, + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The transport addresses where the service can be reached. The scheme and IP part shall match the one used in the request (i.e. the GetServices request)." + }, + { + "name": "Capabilities", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Version", + "type": "{http://www.onvif.org/ver10/schema}OnvifVersion", + "type_name": "OnvifVersion", + "definition": { + "kind": "complexType", + "name": "OnvifVersion", + "fields": [ + { + "name": "Major", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Major version number." + }, + { + "name": "Minor", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Two digit minor version number.\n\t\t\t\t\t\tIf major version number is less than \"16\", X.0.1 maps to \"01\" and X.2.1 maps to \"21\" where X stands for Major version number.\n\t\t\t\t\t\tOtherwise, minor number is month of release, such as \"06\" for June." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The version of the service (not the ONVIF core spec version)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Each Service element contains information about one service." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetServiceCapabilities", + "port_type": "Device", + "description": "Returns the capabilities of the device service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/device/wsdl}DeviceServiceCapabilities", + "type_name": "DeviceServiceCapabilities", + "definition": { + "kind": "complexType", + "name": "DeviceServiceCapabilities", + "fields": [ + { + "name": "Network", + "type": "{http://www.onvif.org/ver10/device/wsdl}NetworkCapabilities", + "type_name": "NetworkCapabilities", + "definition": { + "kind": "complexType", + "name": "NetworkCapabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "IPFilter", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for IP filtering." + }, + { + "use": "optional", + "name": "ZeroConfiguration", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for zeroconf." + }, + { + "use": "optional", + "name": "IPVersion6", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for IPv6." + }, + { + "use": "optional", + "name": "DynDNS", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for dynamic DNS configuration." + }, + { + "use": "optional", + "name": "Dot11Configuration", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for IEEE 802.11 configuration." + }, + { + "use": "optional", + "name": "Dot1XConfigurations", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Indicates the maximum number of Dot1X configurations supported by the device" + }, + { + "use": "optional", + "name": "HostnameFromDHCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for retrieval of hostname from DHCP." + }, + { + "use": "optional", + "name": "NTP", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of NTP servers supported by the devices SetNTP command." + }, + { + "use": "optional", + "name": "DHCPv6", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for Stateful IPv6 DHCP." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Network capabilities." + }, + { + "name": "Security", + "type": "{http://www.onvif.org/ver10/device/wsdl}SecurityCapabilities", + "type_name": "SecurityCapabilities", + "definition": { + "kind": "complexType", + "name": "SecurityCapabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "TLS1.0", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for TLS 1.0." + }, + { + "use": "optional", + "name": "TLS1.1", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for TLS 1.1." + }, + { + "use": "optional", + "name": "TLS1.2", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for TLS 1.2." + }, + { + "use": "optional", + "name": "OnboardKeyGeneration", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for onboard key generation." + }, + { + "use": "optional", + "name": "AccessPolicyConfig", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for access policy configuration." + }, + { + "use": "optional", + "name": "DefaultAccessPolicy", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for the ONVIF default access policy." + }, + { + "use": "optional", + "name": "Dot1X", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for IEEE 802.1X configuration." + }, + { + "use": "optional", + "name": "RemoteUserHandling", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for remote user configuration. Used when accessing another device." + }, + { + "use": "optional", + "name": "X.509Token", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for WS-Security X.509 token." + }, + { + "use": "optional", + "name": "SAMLToken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for WS-Security SAML token." + }, + { + "use": "optional", + "name": "KerberosToken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for WS-Security Kerberos token." + }, + { + "use": "optional", + "name": "UsernameToken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for WS-Security Username token." + }, + { + "use": "optional", + "name": "HttpDigest", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for WS over HTTP digest authenticated communication layer." + }, + { + "use": "optional", + "name": "RELToken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for WS-Security REL token." + }, + { + "use": "optional", + "name": "JsonWebToken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for JWT-based authentication with WS-Security Binary Security token." + }, + { + "use": "optional", + "name": "SupportedEAPMethods", + "type": "{http://www.onvif.org/ver10/schema}IntList", + "definition": { + "kind": "simpleType", + "name": "IntList", + "item_type": "{http://www.w3.org/2001/XMLSchema}int" + }, + "description": "EAP Methods supported by the device. The int values refer to the IANA EAP Registry." + }, + { + "use": "optional", + "name": "MaxUsers", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The maximum number of users that the device supports." + }, + { + "use": "optional", + "name": "MaxUserNameLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of characters supported for the username by CreateUsers." + }, + { + "use": "optional", + "name": "MaxPasswordLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of characters supported for the password by CreateUsers and SetUser." + }, + { + "use": "optional", + "name": "SecurityPolicies", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Indicates which security policies are supported. Options are: ModifyPassword, PasswordComplexity, AuthFailureWarnings" + }, + { + "use": "optional", + "name": "MaxPasswordHistory", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of passwords that the device can remember for each user" + }, + { + "use": "optional", + "name": "HashingAlgorithms", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Supported hashing algorithms as part of HTTP and RTSP Digest authentication.Example: MD5,SHA-256" + }, + { + "use": "optional", + "name": "MaxUserRoles", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Whenever set to an integer greater than zero, it signals that the device supports editable user roles. It indicates the maximum number of editable user roles." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Security capabilities." + }, + { + "name": "System", + "type": "{http://www.onvif.org/ver10/device/wsdl}SystemCapabilities", + "type_name": "SystemCapabilities", + "definition": { + "kind": "complexType", + "name": "SystemCapabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "DiscoveryResolve", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for WS Discovery resolve requests." + }, + { + "use": "optional", + "name": "DiscoveryBye", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for WS-Discovery Bye." + }, + { + "use": "optional", + "name": "RemoteDiscovery", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for remote discovery." + }, + { + "use": "optional", + "name": "SystemBackup", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for system backup through MTOM." + }, + { + "use": "optional", + "name": "SystemLogging", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for retrieval of system logging through MTOM." + }, + { + "use": "optional", + "name": "CloudFirmwareUpgrade", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for firmware upgrade through the cloud." + }, + { + "use": "optional", + "name": "HttpFirmwareUpgrade", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for firmware upgrade through HTTP." + }, + { + "use": "optional", + "name": "HttpSystemBackup", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for system backup through HTTP." + }, + { + "use": "optional", + "name": "HttpSystemLogging", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for retrieval of system logging through HTTP." + }, + { + "use": "optional", + "name": "HttpSupportInformation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for retrieving support information through HTTP." + }, + { + "use": "optional", + "name": "StorageConfiguration", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for storage configuration interfaces." + }, + { + "use": "optional", + "name": "MaxStorageConfigurations", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Indicates maximum number of storage configurations supported." + }, + { + "use": "optional", + "name": "StorageConfigurationRenewal", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for renewal of storage configuration." + }, + { + "use": "optional", + "name": "GeoLocationEntries", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "If present signals support for geo location. The value signals the supported number of entries." + }, + { + "use": "optional", + "name": "AutoGeo", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported automatic GeoLocation adjustment supported by the device. Valid items are defined by tds:AutoGeoMode." + }, + { + "use": "optional", + "name": "StorageTypesSupported", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Enumerates the supported StorageTypes, see tds:StorageType." + }, + { + "use": "optional", + "name": "DiscoveryNotSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates no support for network discovery." + }, + { + "use": "optional", + "name": "NetworkConfigNotSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates no support for network configuration." + }, + { + "use": "optional", + "name": "UserConfigNotSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates no support for user configuration." + }, + { + "use": "optional", + "name": "Addons", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported Addons by the device." + }, + { + "use": "optional", + "name": "HardwareType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Indicates what type of device this is. See tt:HardwareTypes for available options." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "System capabilities." + }, + { + "name": "Misc", + "type": "{http://www.onvif.org/ver10/device/wsdl}MiscCapabilities", + "type_name": "MiscCapabilities", + "definition": { + "kind": "complexType", + "name": "MiscCapabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "AuxiliaryCommands", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Lists of commands supported by SendAuxiliaryCommand." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Capabilities that do not fit in any of the other categories." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the device service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetDeviceInformation", + "port_type": "Device", + "description": "This operation gets basic device information from the device.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDeviceInformationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDeviceInformation", + "schema": { + "name": "GetDeviceInformation", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDeviceInformationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDeviceInformationResponse", + "schema": { + "name": "GetDeviceInformationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Manufacturer", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The manufactor of the device." + }, + { + "name": "Model", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The device model." + }, + { + "name": "FirmwareVersion", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The firmware version in the device." + }, + { + "name": "SerialNumber", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The serial number of the device." + }, + { + "name": "HardwareId", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The hardware ID of the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetSystemDateAndTime", + "port_type": "Device", + "description": "This operation sets the device system date and time. The device shall support the configuration of the daylight saving setting and of the manual system date and time (if applicable) or indication of NTP time (if applicable) through the SetSystemDateAndTime command. If system time and date are set manually, the client shall include UTCDateTime in the request. A TimeZone token which is not formed according to the rules of IEEE 1003.1 section 8.3 is considered as invalid timezone. The DayLightSavings flag should be set to true to activate any DST settings of the TimeZone string. Clear the DayLightSavings flag if the DST portion of the TimeZone settings should be ignored.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetSystemDateAndTimeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetSystemDateAndTime", + "schema": { + "name": "SetSystemDateAndTime", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DateTimeType", + "type": "{http://www.onvif.org/ver10/schema}SetDateTimeType", + "type_name": "SetDateTimeType", + "definition": { + "kind": "simpleType", + "name": "SetDateTimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Manual", + "description": "Indicates that the date and time are set manually." + }, + { + "value": "NTP", + "description": "Indicates that the date and time are set through NTP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines if the date and time is set via NTP or manually." + }, + { + "name": "DaylightSavings", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Automatically adjust Daylight savings if defined in TimeZone." + }, + { + "name": "TimeZone", + "type": "{http://www.onvif.org/ver10/schema}TimeZone", + "type_name": "TimeZone", + "definition": { + "kind": "complexType", + "name": "TimeZone", + "description": "The TZ format is specified by POSIX, please refer to POSIX 1003.1 section 8.3
\n\t\t\t\tExample: Europe, Paris TZ=CET-1CEST,M3.5.0/2,M10.5.0/3
\n\t\t\t\tCET = designation for standard time when daylight saving is not in force
\n\t\t\t\t-1 = offset in hours = negative so 1 hour east of Greenwich meridian
\n\t\t\t\tCEST = designation when daylight saving is in force (\"Central European Summer Time\")
\n\t\t\t\t, = no offset number between code and comma, so default to one hour ahead for daylight saving
\n\t\t\t\tM3.5.0 = when daylight saving starts = the last Sunday in March (the \"5th\" week means the last in the month)
\n\t\t\t\t/2, = the local time when the switch occurs = 2 a.m. in this case
\n\t\t\t\tM10.5.0 = when daylight saving ends = the last Sunday in October.
\n\t\t\t\t/3, = the local time when the switch occurs = 3 a.m. in this case
", + "fields": [ + { + "name": "TZ", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Posix timezone string." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The time zone in POSIX 1003.1 format" + }, + { + "name": "UTCDateTime", + "type": "{http://www.onvif.org/ver10/schema}DateTime", + "type_name": "DateTime", + "definition": { + "kind": "complexType", + "name": "DateTime", + "fields": [ + { + "name": "Time", + "type": "{http://www.onvif.org/ver10/schema}Time", + "type_name": "Time", + "definition": { + "kind": "complexType", + "name": "Time", + "fields": [ + { + "name": "Hour", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 0 to 23." + }, + { + "name": "Minute", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 0 to 59." + }, + { + "name": "Second", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 0 to 61 (typically 59)." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Date", + "type": "{http://www.onvif.org/ver10/schema}Date", + "type_name": "Date", + "definition": { + "kind": "complexType", + "name": "Date", + "fields": [ + { + "name": "Year", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Month", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 1 to 12." + }, + { + "name": "Day", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 1 to 31." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Date and time in UTC. If time is obtained via NTP, UTCDateTime has no meaning" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetSystemDateAndTimeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetSystemDateAndTimeResponse", + "schema": { + "name": "SetSystemDateAndTimeResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetSystemDateAndTime", + "port_type": "Device", + "description": "This operation gets the device system date and time. The device shall support the return of the daylight saving setting and of the manual system date and time (if applicable) or indication of NTP time (if applicable) through the GetSystemDateAndTime command. A device shall provide the UTCDateTime information.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetSystemDateAndTimeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetSystemDateAndTime", + "schema": { + "name": "GetSystemDateAndTime", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetSystemDateAndTimeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetSystemDateAndTimeResponse", + "schema": { + "name": "GetSystemDateAndTimeResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SystemDateAndTime", + "type": "{http://www.onvif.org/ver10/schema}SystemDateTime", + "type_name": "SystemDateTime", + "definition": { + "kind": "complexType", + "name": "SystemDateTime", + "description": "General date time information returned by the GetSystemDateTime method.", + "fields": [ + { + "name": "DateTimeType", + "type": "{http://www.onvif.org/ver10/schema}SetDateTimeType", + "type_name": "SetDateTimeType", + "definition": { + "kind": "simpleType", + "name": "SetDateTimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Manual", + "description": "Indicates that the date and time are set manually." + }, + { + "value": "NTP", + "description": "Indicates that the date and time are set through NTP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the time is set manually or through NTP." + }, + { + "name": "DaylightSavings", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative indicator whether daylight savings is currently on/off." + }, + { + "name": "TimeZone", + "type": "{http://www.onvif.org/ver10/schema}TimeZone", + "type_name": "TimeZone", + "definition": { + "kind": "complexType", + "name": "TimeZone", + "description": "The TZ format is specified by POSIX, please refer to POSIX 1003.1 section 8.3
\n\t\t\t\tExample: Europe, Paris TZ=CET-1CEST,M3.5.0/2,M10.5.0/3
\n\t\t\t\tCET = designation for standard time when daylight saving is not in force
\n\t\t\t\t-1 = offset in hours = negative so 1 hour east of Greenwich meridian
\n\t\t\t\tCEST = designation when daylight saving is in force (\"Central European Summer Time\")
\n\t\t\t\t, = no offset number between code and comma, so default to one hour ahead for daylight saving
\n\t\t\t\tM3.5.0 = when daylight saving starts = the last Sunday in March (the \"5th\" week means the last in the month)
\n\t\t\t\t/2, = the local time when the switch occurs = 2 a.m. in this case
\n\t\t\t\tM10.5.0 = when daylight saving ends = the last Sunday in October.
\n\t\t\t\t/3, = the local time when the switch occurs = 3 a.m. in this case
", + "fields": [ + { + "name": "TZ", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Posix timezone string." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Timezone information in Posix format." + }, + { + "name": "UTCDateTime", + "type": "{http://www.onvif.org/ver10/schema}DateTime", + "type_name": "DateTime", + "definition": { + "kind": "complexType", + "name": "DateTime", + "fields": [ + { + "name": "Time", + "type": "{http://www.onvif.org/ver10/schema}Time", + "type_name": "Time", + "definition": { + "kind": "complexType", + "name": "Time", + "fields": [ + { + "name": "Hour", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 0 to 23." + }, + { + "name": "Minute", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 0 to 59." + }, + { + "name": "Second", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 0 to 61 (typically 59)." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Date", + "type": "{http://www.onvif.org/ver10/schema}Date", + "type_name": "Date", + "definition": { + "kind": "complexType", + "name": "Date", + "fields": [ + { + "name": "Year", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Month", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 1 to 12." + }, + { + "name": "Day", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 1 to 31." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Current system date and time in UTC format. This field is mandatory since version 2.0." + }, + { + "name": "LocalDateTime", + "type": "{http://www.onvif.org/ver10/schema}DateTime", + "type_name": "DateTime", + "definition": { + "kind": "complexType", + "name": "DateTime", + "fields": [ + { + "name": "Time", + "type": "{http://www.onvif.org/ver10/schema}Time", + "type_name": "Time", + "definition": { + "kind": "complexType", + "name": "Time", + "fields": [ + { + "name": "Hour", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 0 to 23." + }, + { + "name": "Minute", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 0 to 59." + }, + { + "name": "Second", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 0 to 61 (typically 59)." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Date", + "type": "{http://www.onvif.org/ver10/schema}Date", + "type_name": "Date", + "definition": { + "kind": "complexType", + "name": "Date", + "fields": [ + { + "name": "Year", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Month", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 1 to 12." + }, + { + "name": "Day", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range is 1 to 31." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Date and time in local format." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SystemDateTimeExtension", + "type_name": "SystemDateTimeExtension", + "definition": { + "kind": "complexType", + "name": "SystemDateTimeExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains information whether system date and time are set manually or by NTP, daylight savings is on or off, time zone in POSIX 1003.1 format and system date and time in UTC and also local system date and time." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetSystemFactoryDefault", + "port_type": "Device", + "description": "This operation reloads the parameters on the device to their factory default values.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetSystemFactoryDefaultRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetSystemFactoryDefault", + "schema": { + "name": "SetSystemFactoryDefault", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "FactoryDefault", + "type": "{http://www.onvif.org/ver10/schema}FactoryDefaultType", + "type_name": "FactoryDefaultType", + "definition": { + "kind": "simpleType", + "name": "FactoryDefaultType", + "description": "Enumeration describing the available factory default modes.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Hard", + "description": "Indicates that a hard factory default is requested." + }, + { + "value": "Soft", + "description": "Indicates that a soft factory default is requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the factory default action type." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetSystemFactoryDefaultResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetSystemFactoryDefaultResponse", + "schema": { + "name": "SetSystemFactoryDefaultResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "UpgradeSystemFirmware", + "port_type": "Device", + "description": "This operation upgrades a device firmware version. After a successful upgrade the response message is sent before the device reboots. The device should support firmware upgrade through the UpgradeSystemFirmware command. The exact format of the firmware data is outside the scope of this standard.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}UpgradeSystemFirmwareRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}UpgradeSystemFirmware", + "schema": { + "name": "UpgradeSystemFirmware", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Firmware", + "type": "{http://www.onvif.org/ver10/schema}AttachmentData", + "type_name": "AttachmentData", + "definition": { + "kind": "complexType", + "name": "AttachmentData", + "fields": [ + { + "ref": "{http://www.w3.org/2004/08/xop/include}Include", + "name": "Include", + "unresolved": true, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}UpgradeSystemFirmwareResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}UpgradeSystemFirmwareResponse", + "schema": { + "name": "UpgradeSystemFirmwareResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Message", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SystemReboot", + "port_type": "Device", + "description": "This operation reboots the device.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SystemRebootRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SystemReboot", + "schema": { + "name": "SystemReboot", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SystemRebootResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SystemRebootResponse", + "schema": { + "name": "SystemRebootResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Message", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the reboot message sent by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "RestoreSystem", + "port_type": "Device", + "description": "This operation restores the system backup configuration files(s) previously retrieved from a device. The device should support restore of backup configuration file(s) through the RestoreSystem command. The exact format of the backup configuration file(s) is outside the scope of this standard. If the command is supported, it shall accept backup files returned by the GetSystemBackup command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}RestoreSystemRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}RestoreSystem", + "schema": { + "name": "RestoreSystem", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "BackupFiles", + "type": "{http://www.onvif.org/ver10/schema}BackupFile", + "type_name": "BackupFile", + "definition": { + "kind": "complexType", + "name": "BackupFile", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Data", + "type": "{http://www.onvif.org/ver10/schema}AttachmentData", + "type_name": "AttachmentData", + "definition": { + "kind": "complexType", + "name": "AttachmentData", + "fields": [ + { + "ref": "{http://www.w3.org/2004/08/xop/include}Include", + "name": "Include", + "unresolved": true, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}RestoreSystemResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}RestoreSystemResponse", + "schema": { + "name": "RestoreSystemResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetSystemBackup", + "port_type": "Device", + "description": "This operation is retrieves system backup configuration file(s) from a device. The device should support return of back up configuration file(s) through the GetSystemBackup command. The backup is returned with reference to a name and mime-type together with binary data. The exact format of the backup configuration files is outside the scope of this standard.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetSystemBackupRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetSystemBackup", + "schema": { + "name": "GetSystemBackup", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetSystemBackupResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetSystemBackupResponse", + "schema": { + "name": "GetSystemBackupResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "BackupFiles", + "type": "{http://www.onvif.org/ver10/schema}BackupFile", + "type_name": "BackupFile", + "definition": { + "kind": "complexType", + "name": "BackupFile", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Data", + "type": "{http://www.onvif.org/ver10/schema}AttachmentData", + "type_name": "AttachmentData", + "definition": { + "kind": "complexType", + "name": "AttachmentData", + "fields": [ + { + "ref": "{http://www.w3.org/2004/08/xop/include}Include", + "name": "Include", + "unresolved": true, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetSystemLog", + "port_type": "Device", + "description": "This operation gets a system log from the device. The exact format of the system logs is outside the scope of this standard.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetSystemLogRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetSystemLog", + "schema": { + "name": "GetSystemLog", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "LogType", + "type": "{http://www.onvif.org/ver10/schema}SystemLogType", + "type_name": "SystemLogType", + "definition": { + "kind": "simpleType", + "name": "SystemLogType", + "description": "Enumeration describing the available system log modes.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "System", + "description": "Indicates that a system log is requested." + }, + { + "value": "Access", + "description": "Indicates that a access log is requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the type of system log to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetSystemLogResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetSystemLogResponse", + "schema": { + "name": "GetSystemLogResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SystemLog", + "type": "{http://www.onvif.org/ver10/schema}SystemLog", + "type_name": "SystemLog", + "definition": { + "kind": "complexType", + "name": "SystemLog", + "fields": [ + { + "name": "Binary", + "type": "{http://www.onvif.org/ver10/schema}AttachmentData", + "type_name": "AttachmentData", + "definition": { + "kind": "complexType", + "name": "AttachmentData", + "fields": [ + { + "ref": "{http://www.w3.org/2004/08/xop/include}Include", + "name": "Include", + "unresolved": true, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The log information as attachment data." + }, + { + "name": "String", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The log information as character data." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the system log information." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetSystemSupportInformation", + "port_type": "Device", + "description": "This operation gets arbitary device diagnostics information from the device.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetSystemSupportInformationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetSystemSupportInformation", + "schema": { + "name": "GetSystemSupportInformation", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetSystemSupportInformationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetSystemSupportInformationResponse", + "schema": { + "name": "GetSystemSupportInformationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SupportInformation", + "type": "{http://www.onvif.org/ver10/schema}SupportInformation", + "type_name": "SupportInformation", + "definition": { + "kind": "complexType", + "name": "SupportInformation", + "fields": [ + { + "name": "Binary", + "type": "{http://www.onvif.org/ver10/schema}AttachmentData", + "type_name": "AttachmentData", + "definition": { + "kind": "complexType", + "name": "AttachmentData", + "fields": [ + { + "ref": "{http://www.w3.org/2004/08/xop/include}Include", + "name": "Include", + "unresolved": true, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The support information as attachment data." + }, + { + "name": "String", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The support information as character data." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the arbitary device diagnostics information." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetScopes", + "port_type": "Device", + "description": "This operation requests the scope parameters of a device. The scope parameters are used in the device discovery to match a probe message, see Section 7. The Scope parameters are of two different types: Fixed Configurable Fixed scope parameters are permanent device characteristics and cannot be removed through the device management interface. The scope type is indicated in the scope list returned in the get scope parameters response. A device shall support retrieval of discovery scope parameters through the GetScopes command. As some scope parameters are mandatory, the device shall return a non-empty scope list in the response.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetScopesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetScopes", + "schema": { + "name": "GetScopes", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetScopesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetScopesResponse", + "schema": { + "name": "GetScopesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Scopes", + "type": "{http://www.onvif.org/ver10/schema}Scope", + "type_name": "Scope", + "definition": { + "kind": "complexType", + "name": "Scope", + "fields": [ + { + "name": "ScopeDef", + "type": "{http://www.onvif.org/ver10/schema}ScopeDefinition", + "type_name": "ScopeDefinition", + "definition": { + "kind": "simpleType", + "name": "ScopeDefinition", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Fixed" + }, + { + "value": "Configurable" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the scope is fixed or configurable." + }, + { + "name": "ScopeItem", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Scope item URI." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of URI definining the device scopes. Scope parameters can be of two types: fixed and configurable. Fixed parameters can not be altered." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetScopes", + "port_type": "Device", + "description": "This operation sets the scope parameters of a device. The scope parameters are used in the device discovery to match a probe message. This operation replaces all existing configurable scope parameters (not fixed parameters). If this shall be avoided, one should use the scope add command instead. The device shall support configuration of discovery scope parameters through the SetScopes command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetScopesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetScopes", + "schema": { + "name": "SetScopes", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Scopes", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of scope parameters that will replace all existing configurable scope parameters." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetScopesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetScopesResponse", + "schema": { + "name": "SetScopesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "AddScopes", + "port_type": "Device", + "description": "This operation adds new configurable scope parameters to a device. The scope parameters are used in the device discovery to match a probe message. The device shall support addition of discovery scope parameters through the AddScopes command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}AddScopesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}AddScopes", + "schema": { + "name": "AddScopes", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ScopeItem", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of new configurable scope parameters that will be added to the existing configurable scope." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}AddScopesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}AddScopesResponse", + "schema": { + "name": "AddScopesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "RemoveScopes", + "port_type": "Device", + "description": "This operation deletes scope-configurable scope parameters from a device. The scope parameters are used in the device discovery to match a probe message, see Section 7. The device shall support deletion of discovery scope parameters through the RemoveScopes command. Table", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}RemoveScopesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}RemoveScopes", + "schema": { + "name": "RemoveScopes", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ScopeItem", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of URIs that should be removed from the device scope.
\n\t\t\t\t\t\t\t\t\tNote that the response message always will match the request or an error will be returned. The use of the response is for that reason deprecated." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}RemoveScopesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}RemoveScopesResponse", + "schema": { + "name": "RemoveScopesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ScopeItem", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of URIs that has been removed from the device scope" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetDiscoveryMode", + "port_type": "Device", + "description": "This operation gets the discovery mode of a device. See Section 7.2 for the definition of the different device discovery modes. The device shall support retrieval of the discovery mode setting through the GetDiscoveryMode command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDiscoveryModeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDiscoveryMode", + "schema": { + "name": "GetDiscoveryMode", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDiscoveryModeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDiscoveryModeResponse", + "schema": { + "name": "GetDiscoveryModeResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DiscoveryMode", + "type": "{http://www.onvif.org/ver10/schema}DiscoveryMode", + "type_name": "DiscoveryMode", + "definition": { + "kind": "simpleType", + "name": "DiscoveryMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Discoverable" + }, + { + "value": "NonDiscoverable" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicator of discovery mode: Discoverable, NonDiscoverable." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetDiscoveryMode", + "port_type": "Device", + "description": "This operation sets the discovery mode operation of a device. See Section 7.2 for the definition of the different device discovery modes. The device shall support configuration of the discovery mode setting through the SetDiscoveryMode command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetDiscoveryModeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetDiscoveryMode", + "schema": { + "name": "SetDiscoveryMode", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DiscoveryMode", + "type": "{http://www.onvif.org/ver10/schema}DiscoveryMode", + "type_name": "DiscoveryMode", + "definition": { + "kind": "simpleType", + "name": "DiscoveryMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Discoverable" + }, + { + "value": "NonDiscoverable" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicator of discovery mode: Discoverable, NonDiscoverable." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetDiscoveryModeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetDiscoveryModeResponse", + "schema": { + "name": "SetDiscoveryModeResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetRemoteDiscoveryMode", + "port_type": "Device", + "description": "This operation gets the remote discovery mode of a device. See Section 7.4 for the definition of remote discovery extensions. A device that supports remote discovery shall support retrieval of the remote discovery mode setting through the GetRemoteDiscoveryMode command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetRemoteDiscoveryModeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetRemoteDiscoveryMode", + "schema": { + "name": "GetRemoteDiscoveryMode", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetRemoteDiscoveryModeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetRemoteDiscoveryModeResponse", + "schema": { + "name": "GetRemoteDiscoveryModeResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RemoteDiscoveryMode", + "type": "{http://www.onvif.org/ver10/schema}DiscoveryMode", + "type_name": "DiscoveryMode", + "definition": { + "kind": "simpleType", + "name": "DiscoveryMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Discoverable" + }, + { + "value": "NonDiscoverable" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicator of discovery mode: Discoverable, NonDiscoverable." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetRemoteDiscoveryMode", + "port_type": "Device", + "description": "This operation sets the remote discovery mode of operation of a device. See Section 7.4 for the definition of remote discovery remote extensions. A device that supports remote discovery shall support configuration of the discovery mode setting through the SetRemoteDiscoveryMode command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetRemoteDiscoveryModeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetRemoteDiscoveryMode", + "schema": { + "name": "SetRemoteDiscoveryMode", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RemoteDiscoveryMode", + "type": "{http://www.onvif.org/ver10/schema}DiscoveryMode", + "type_name": "DiscoveryMode", + "definition": { + "kind": "simpleType", + "name": "DiscoveryMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Discoverable" + }, + { + "value": "NonDiscoverable" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicator of discovery mode: Discoverable, NonDiscoverable." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetRemoteDiscoveryModeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetRemoteDiscoveryModeResponse", + "schema": { + "name": "SetRemoteDiscoveryModeResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetDPAddresses", + "port_type": "Device", + "description": "This operation gets the remote DP address or addresses from a device. If the device supports remote discovery, as specified in Section 7.4, the device shall support retrieval of the remote DP address(es) through the GetDPAddresses command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDPAddressesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDPAddresses", + "schema": { + "name": "GetDPAddresses", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDPAddressesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDPAddressesResponse", + "schema": { + "name": "GetDPAddressesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DPAddress", + "type": "{http://www.onvif.org/ver10/schema}NetworkHost", + "type_name": "NetworkHost", + "definition": { + "kind": "complexType", + "name": "NetworkHost", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}NetworkHostType", + "type_name": "NetworkHostType", + "definition": { + "kind": "simpleType", + "name": "NetworkHostType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + }, + { + "value": "DNS" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Network host type: IPv4, IPv6 or DNS." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address." + }, + { + "name": "DNSname", + "type": "{http://www.onvif.org/ver10/schema}DNSName", + "type_name": "DNSName", + "definition": { + "kind": "simpleType", + "name": "DNSName", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "DNS name." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkHostExtension", + "type_name": "NetworkHostExtension", + "definition": { + "kind": "complexType", + "name": "NetworkHostExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetDPAddresses", + "port_type": "Device", + "description": "This operation sets the remote DP address or addresses on a device. If the device supports remote discovery, as specified in Section 7.4, the device shall support configuration of the remote DP address(es) through the SetDPAddresses command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetDPAddressesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetDPAddresses", + "schema": { + "name": "SetDPAddresses", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DPAddress", + "type": "{http://www.onvif.org/ver10/schema}NetworkHost", + "type_name": "NetworkHost", + "definition": { + "kind": "complexType", + "name": "NetworkHost", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}NetworkHostType", + "type_name": "NetworkHostType", + "definition": { + "kind": "simpleType", + "name": "NetworkHostType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + }, + { + "value": "DNS" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Network host type: IPv4, IPv6 or DNS." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address." + }, + { + "name": "DNSname", + "type": "{http://www.onvif.org/ver10/schema}DNSName", + "type_name": "DNSName", + "definition": { + "kind": "simpleType", + "name": "DNSName", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "DNS name." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkHostExtension", + "type_name": "NetworkHostExtension", + "definition": { + "kind": "complexType", + "name": "NetworkHostExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetDPAddressesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetDPAddressesResponse", + "schema": { + "name": "SetDPAddressesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetEndpointReference", + "port_type": "Device", + "description": "A client can ask for the device service endpoint reference address property that can be used to derive the password equivalent for remote user operation. The device shall support the GetEndpointReference command returning the address property of the device service endpoint reference.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetEndpointReferenceRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetEndpointReference", + "schema": { + "name": "GetEndpointReference", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetEndpointReferenceResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetEndpointReferenceResponse", + "schema": { + "name": "GetEndpointReferenceResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "GUID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetUserRoles", + "port_type": "Device", + "description": "This operation returns the editable user levels configured in the device. Whenever an editable user level is passed in the request, information only about that level is returned.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetUserRolesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetUserRoles", + "schema": { + "name": "GetUserRoles", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "UserRole", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetUserRolesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetUserRolesResponse", + "schema": { + "name": "GetUserRolesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "UserRole", + "type": "{http://www.onvif.org/ver10/schema}UserRole", + "type_name": "UserRole", + "definition": { + "kind": "complexType", + "name": "UserRole", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Name of the editable user level." + }, + { + "name": "Functions", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Names of the permitted function for the editable user level. The names must be prepended by the namespace prefix and colon." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetUserRole", + "port_type": "Device", + "description": "This operation configures an editable user level in the device. If the level passed in UserRole already exists in the device, its configuration is overwritten. Otherwise, a new editable user level is created.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetUserRoleRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetUserRole", + "schema": { + "name": "SetUserRole", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "UserRole", + "type": "{http://www.onvif.org/ver10/schema}UserRole", + "type_name": "UserRole", + "definition": { + "kind": "complexType", + "name": "UserRole", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Name of the editable user level." + }, + { + "name": "Functions", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Names of the permitted function for the editable user level. The names must be prepended by the namespace prefix and colon." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetUserRoleResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetUserRoleResponse", + "schema": { + "name": "SetUserRoleResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "DeleteUserRole", + "port_type": "Device", + "description": "This operation deletes an editable user level in the device.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}DeleteUserRoleRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}DeleteUserRole", + "schema": { + "name": "DeleteUserRole", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "UserRole", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}DeleteUserRoleResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}DeleteUserRoleResponse", + "schema": { + "name": "DeleteUserRoleResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetRemoteUser", + "port_type": "Device", + "description": "This operation returns the configured remote user (if any). A device supporting remote user handling shall support this operation. The user is only valid for the WS-UserToken profile or as an HTTP / RTSP user. The algorithm to use for deriving the password is described in section 5.12.2.1 of the core specification.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetRemoteUserRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetRemoteUser", + "schema": { + "name": "GetRemoteUser", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetRemoteUserResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetRemoteUserResponse", + "schema": { + "name": "GetRemoteUserResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RemoteUser", + "type": "{http://www.onvif.org/ver10/schema}RemoteUser", + "type_name": "RemoteUser", + "definition": { + "kind": "complexType", + "name": "RemoteUser", + "fields": [ + { + "name": "Username", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "UseDerivedPassword", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetRemoteUser", + "port_type": "Device", + "description": "This operation sets the remote user. A device supporting remote user handling shall support this operation. The user is only valid for the WS-UserToken profile or as an HTTP / RTSP user. The password that is set shall always be the original (not derived) password. If UseDerivedPassword is set password derivation shall be done by the device when connecting to a remote device.The algorithm to use for deriving the password is described in section 5.12.2.1 of the core specification. To remove the remote user SetRemoteUser should be called without the RemoteUser parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetRemoteUserRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetRemoteUser", + "schema": { + "name": "SetRemoteUser", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RemoteUser", + "type": "{http://www.onvif.org/ver10/schema}RemoteUser", + "type_name": "RemoteUser", + "definition": { + "kind": "complexType", + "name": "RemoteUser", + "fields": [ + { + "name": "Username", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "UseDerivedPassword", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetRemoteUserResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetRemoteUserResponse", + "schema": { + "name": "SetRemoteUserResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetUsers", + "port_type": "Device", + "description": "This operation lists the registered users and corresponding credentials on a device. The device shall support retrieval of registered device users and their credentials for the user token through the GetUsers command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetUsersRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetUsers", + "schema": { + "name": "GetUsers", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetUsersResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetUsersResponse", + "schema": { + "name": "GetUsersResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "User", + "type": "{http://www.onvif.org/ver10/schema}User", + "type_name": "User", + "definition": { + "kind": "complexType", + "name": "User", + "fields": [ + { + "name": "Username", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Username string." + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Password string." + }, + { + "name": "UserLevel", + "type": "{http://www.onvif.org/ver10/schema}UserLevel", + "type_name": "UserLevel", + "definition": { + "kind": "simpleType", + "name": "UserLevel", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Administrator" + }, + { + "value": "Operator" + }, + { + "value": "User" + }, + { + "value": "Anonymous" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User level string." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}UserExtension", + "type_name": "UserExtension", + "definition": { + "kind": "complexType", + "name": "UserExtension", + "fields": [ + { + "name": "Roles", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The names of the roles assigned to the user." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of the onvif users and following information is included in each entry: username and user level." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "CreateUsers", + "port_type": "Device", + "description": "This operation creates new device users and corresponding credentials on a device for authentication purposes. The device shall support creation of device users and their credentials through the CreateUsers command. Either all users are created successfully or a fault message shall be returned without creating any user. ONVIF compliant devices are recommended to support password length of at least 28 bytes, as clients may follow the password derivation mechanism which results in 'password equivalent' of length 28 bytes, as described in section 3.1.2 of the ONVIF security white paper.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}CreateUsersRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}CreateUsers", + "schema": { + "name": "CreateUsers", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "User", + "type": "{http://www.onvif.org/ver10/schema}User", + "type_name": "User", + "definition": { + "kind": "complexType", + "name": "User", + "fields": [ + { + "name": "Username", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Username string." + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Password string." + }, + { + "name": "UserLevel", + "type": "{http://www.onvif.org/ver10/schema}UserLevel", + "type_name": "UserLevel", + "definition": { + "kind": "simpleType", + "name": "UserLevel", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Administrator" + }, + { + "value": "Operator" + }, + { + "value": "User" + }, + { + "value": "Anonymous" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User level string." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}UserExtension", + "type_name": "UserExtension", + "definition": { + "kind": "complexType", + "name": "UserExtension", + "fields": [ + { + "name": "Roles", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The names of the roles assigned to the user." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Creates new device users and corresponding credentials. Each user entry includes: username, password and user level. Either all users are created successfully or a fault message MUST be returned without creating any user. If trying to create several users with exactly the same username the request is rejected and no users are created. If password is missing, then fault message Too weak password is returned." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}CreateUsersResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}CreateUsersResponse", + "schema": { + "name": "CreateUsersResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "DeleteUsers", + "port_type": "Device", + "description": "This operation deletes users on a device. The device shall support deletion of device users and their credentials through the DeleteUsers command. A device may have one or more fixed users that cannot be deleted to ensure access to the unit. Either all users are deleted successfully or a fault message shall be returned and no users be deleted.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}DeleteUsersRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}DeleteUsers", + "schema": { + "name": "DeleteUsers", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Username", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Deletes users on an device and there may exist users that cannot be deleted to ensure access to the unit. Either all users are deleted successfully or a fault message MUST be returned and no users be deleted. If a username exists multiple times in the request, then a fault message is returned." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}DeleteUsersResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}DeleteUsersResponse", + "schema": { + "name": "DeleteUsersResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetUser", + "port_type": "Device", + "description": "This operation updates the settings for one or several users on a device for authentication purposes. The device shall support update of device users and their credentials through the SetUser command. Either all change requests are processed successfully or a fault message shall be returned and no change requests be processed.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetUserRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetUser", + "schema": { + "name": "SetUser", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "User", + "type": "{http://www.onvif.org/ver10/schema}User", + "type_name": "User", + "definition": { + "kind": "complexType", + "name": "User", + "fields": [ + { + "name": "Username", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Username string." + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Password string." + }, + { + "name": "UserLevel", + "type": "{http://www.onvif.org/ver10/schema}UserLevel", + "type_name": "UserLevel", + "definition": { + "kind": "simpleType", + "name": "UserLevel", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Administrator" + }, + { + "value": "Operator" + }, + { + "value": "User" + }, + { + "value": "Anonymous" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User level string." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}UserExtension", + "type_name": "UserExtension", + "definition": { + "kind": "complexType", + "name": "UserExtension", + "fields": [ + { + "name": "Roles", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The names of the roles assigned to the user." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Updates the credentials for one or several users on an device. Either all change requests are processed successfully or a fault message MUST be returned. If the request contains the same username multiple times, a fault message is returned." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetUserResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetUserResponse", + "schema": { + "name": "SetUserResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetWsdlUrl", + "port_type": "Device", + "description": "This method allows to provide a URL where product specific WSDL and schema definitions can be retrieved. This method is deprecated.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetWsdlUrlRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetWsdlUrl", + "schema": { + "name": "GetWsdlUrl", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetWsdlUrlResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetWsdlUrlResponse", + "schema": { + "name": "GetWsdlUrlResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "WsdlUrl", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetPasswordComplexityOptions", + "port_type": "Device", + "description": "This method allows retrieval of all the available parameters and their valid ranges for the password complexity configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetPasswordComplexityOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetPasswordComplexityOptions", + "schema": { + "name": "GetPasswordComplexityOptions", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetPasswordComplexityOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetPasswordComplexityOptionsResponse", + "schema": { + "name": "GetPasswordComplexityOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "MinLenRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "UppercaseRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "NumberRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SpecialCharsRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "BlockUsernameOccurrenceSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "PolicyConfigurationLockSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetPasswordComplexityConfiguration", + "port_type": "Device", + "description": "This method allows retrieval of the current password complexity configuration settings.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetPasswordComplexityConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetPasswordComplexityConfiguration", + "schema": { + "name": "GetPasswordComplexityConfiguration", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetPasswordComplexityConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetPasswordComplexityConfigurationResponse", + "schema": { + "name": "GetPasswordComplexityConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "MinLen", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Uppercase", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Number", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SpecialChars", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "BlockUsernameOccurrence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "PolicyConfigurationLocked", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetPasswordComplexityConfiguration", + "port_type": "Device", + "description": "This method allows setting of the password complexity configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetPasswordComplexityConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetPasswordComplexityConfiguration", + "schema": { + "name": "SetPasswordComplexityConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "MinLen", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Uppercase", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Number", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SpecialChars", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "BlockUsernameOccurrence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "PolicyConfigurationLocked", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetPasswordComplexityConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetPasswordComplexityConfigurationResponse", + "schema": { + "name": "SetPasswordComplexityConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetPasswordHistoryConfiguration", + "port_type": "Device", + "description": "This method allows retrieval of the current password history configuration settings.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetPasswordHistoryConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetPasswordHistoryConfiguration", + "schema": { + "name": "GetPasswordHistoryConfiguration", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetPasswordHistoryConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetPasswordHistoryConfigurationResponse", + "schema": { + "name": "GetPasswordHistoryConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Length", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetPasswordHistoryConfiguration", + "port_type": "Device", + "description": "This method allows setting of the password history configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetPasswordHistoryConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetPasswordHistoryConfiguration", + "schema": { + "name": "SetPasswordHistoryConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Length", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetPasswordHistoryConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetPasswordHistoryConfigurationResponse", + "schema": { + "name": "SetPasswordHistoryConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetAuthFailureWarningOptions", + "port_type": "Device", + "description": "This method allows retrieval of all the available parameters and their valid ranges for the authentication failure warning configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetAuthFailureWarningOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetAuthFailureWarningOptions", + "schema": { + "name": "GetAuthFailureWarningOptions", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetAuthFailureWarningOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetAuthFailureWarningOptionsResponse", + "schema": { + "name": "GetAuthFailureWarningOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "MonitorPeriodRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AuthFailureRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetAuthFailureWarningConfiguration", + "port_type": "Device", + "description": "This method allows retrieval of the current authentication failure warning configuration settings.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetAuthFailureWarningConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetAuthFailureWarningConfiguration", + "schema": { + "name": "GetAuthFailureWarningConfiguration", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetAuthFailureWarningConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetAuthFailureWarningConfigurationResponse", + "schema": { + "name": "GetAuthFailureWarningConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MonitorPeriod", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MaxAuthFailures", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetAuthFailureWarningConfiguration", + "port_type": "Device", + "description": "This method allows setting of the authentication failure warning configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetAuthFailureWarningConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetAuthFailureWarningConfiguration", + "schema": { + "name": "SetAuthFailureWarningConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MonitorPeriod", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MaxAuthFailures", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetAuthFailureWarningConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetAuthFailureWarningConfigurationResponse", + "schema": { + "name": "SetAuthFailureWarningConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetCapabilities", + "port_type": "Device", + "description": "This method has been replaced by the more generic GetServices method. For capabilities of individual services refer to the GetServiceCapabilities methods.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetCapabilities", + "schema": { + "name": "GetCapabilities", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Category", + "type": "{http://www.onvif.org/ver10/schema}CapabilityCategory", + "type_name": "CapabilityCategory", + "definition": { + "kind": "simpleType", + "name": "CapabilityCategory", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "All" + }, + { + "value": "Analytics" + }, + { + "value": "Device" + }, + { + "value": "Events" + }, + { + "value": "Imaging" + }, + { + "value": "Media" + }, + { + "value": "PTZ" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of categories to retrieve capability information on." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetCapabilitiesResponse", + "schema": { + "name": "GetCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/schema}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [ + { + "name": "Analytics", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsCapabilities", + "type_name": "AnalyticsCapabilities", + "definition": { + "kind": "complexType", + "name": "AnalyticsCapabilities", + "fields": [ + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Analytics service URI." + }, + { + "name": "RuleSupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not rules are supported." + }, + { + "name": "AnalyticsModuleSupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not modules are supported." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Analytics capabilities" + }, + { + "name": "Device", + "type": "{http://www.onvif.org/ver10/schema}DeviceCapabilities", + "type_name": "DeviceCapabilities", + "definition": { + "kind": "complexType", + "name": "DeviceCapabilities", + "fields": [ + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Device service URI." + }, + { + "name": "Network", + "type": "{http://www.onvif.org/ver10/schema}NetworkCapabilities", + "type_name": "NetworkCapabilities", + "definition": { + "kind": "complexType", + "name": "NetworkCapabilities", + "fields": [ + { + "name": "IPFilter", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not IP filtering is supported." + }, + { + "name": "ZeroConfiguration", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not zeroconf is supported." + }, + { + "name": "IPVersion6", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not IPv6 is supported." + }, + { + "name": "DynDNS", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not is supported." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkCapabilitiesExtension", + "type_name": "NetworkCapabilitiesExtension", + "definition": { + "kind": "complexType", + "name": "NetworkCapabilitiesExtension", + "fields": [ + { + "name": "Dot11Configuration", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkCapabilitiesExtension2", + "type_name": "NetworkCapabilitiesExtension2", + "definition": { + "kind": "complexType", + "name": "NetworkCapabilitiesExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Network capabilities." + }, + { + "name": "System", + "type": "{http://www.onvif.org/ver10/schema}SystemCapabilities", + "type_name": "SystemCapabilities", + "definition": { + "kind": "complexType", + "name": "SystemCapabilities", + "fields": [ + { + "name": "DiscoveryResolve", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not WS Discovery resolve requests are supported." + }, + { + "name": "DiscoveryBye", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not WS-Discovery Bye is supported." + }, + { + "name": "RemoteDiscovery", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not remote discovery is supported." + }, + { + "name": "SystemBackup", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not system backup is supported." + }, + { + "name": "SystemLogging", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not system logging is supported." + }, + { + "name": "FirmwareUpgrade", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not firmware upgrade is supported." + }, + { + "name": "SupportedVersions", + "type": "{http://www.onvif.org/ver10/schema}OnvifVersion", + "type_name": "OnvifVersion", + "definition": { + "kind": "complexType", + "name": "OnvifVersion", + "fields": [ + { + "name": "Major", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Major version number." + }, + { + "name": "Minor", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Two digit minor version number.\n\t\t\t\t\t\tIf major version number is less than \"16\", X.0.1 maps to \"01\" and X.2.1 maps to \"21\" where X stands for Major version number.\n\t\t\t\t\t\tOtherwise, minor number is month of release, such as \"06\" for June." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Indicates supported ONVIF version(s)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SystemCapabilitiesExtension", + "type_name": "SystemCapabilitiesExtension", + "definition": { + "kind": "complexType", + "name": "SystemCapabilitiesExtension", + "fields": [ + { + "name": "HttpFirmwareUpgrade", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "HttpSystemBackup", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "HttpSystemLogging", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "HttpSupportInformation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SystemCapabilitiesExtension2", + "type_name": "SystemCapabilitiesExtension2", + "definition": { + "kind": "complexType", + "name": "SystemCapabilitiesExtension2", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "System capabilities." + }, + { + "name": "IO", + "type": "{http://www.onvif.org/ver10/schema}IOCapabilities", + "type_name": "IOCapabilities", + "definition": { + "kind": "complexType", + "name": "IOCapabilities", + "fields": [ + { + "name": "InputConnectors", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Number of input connectors." + }, + { + "name": "RelayOutputs", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Number of relay outputs." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}IOCapabilitiesExtension", + "type_name": "IOCapabilitiesExtension", + "definition": { + "kind": "complexType", + "name": "IOCapabilitiesExtension", + "fields": [ + { + "name": "Auxiliary", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AuxiliaryCommands", + "type": "{http://www.onvif.org/ver10/schema}AuxiliaryData", + "type_name": "AuxiliaryData", + "definition": { + "kind": "simpleType", + "name": "AuxiliaryData", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "128" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}IOCapabilitiesExtension2", + "type_name": "IOCapabilitiesExtension2", + "definition": { + "kind": "complexType", + "name": "IOCapabilitiesExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "I/O capabilities." + }, + { + "name": "Security", + "type": "{http://www.onvif.org/ver10/schema}SecurityCapabilities", + "type_name": "SecurityCapabilities", + "definition": { + "kind": "complexType", + "name": "SecurityCapabilities", + "fields": [ + { + "name": "TLS1.1", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not TLS 1.1 is supported." + }, + { + "name": "TLS1.2", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not TLS 1.2 is supported." + }, + { + "name": "OnboardKeyGeneration", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not onboard key generation is supported." + }, + { + "name": "AccessPolicyConfig", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not access policy configuration is supported." + }, + { + "name": "X.509Token", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not WS-Security X.509 token is supported." + }, + { + "name": "SAMLToken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not WS-Security SAML token is supported." + }, + { + "name": "KerberosToken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not WS-Security Kerberos token is supported." + }, + { + "name": "RELToken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not WS-Security REL token is supported." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SecurityCapabilitiesExtension", + "type_name": "SecurityCapabilitiesExtension", + "definition": { + "kind": "complexType", + "name": "SecurityCapabilitiesExtension", + "fields": [ + { + "name": "TLS1.0", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SecurityCapabilitiesExtension2", + "type_name": "SecurityCapabilitiesExtension2", + "definition": { + "kind": "complexType", + "name": "SecurityCapabilitiesExtension2", + "fields": [ + { + "name": "Dot1X", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedEAPMethod", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "EAP Methods supported by the device. The int values refer to the IANA EAP Registry." + }, + { + "name": "RemoteUserHandling", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Security capabilities." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}DeviceCapabilitiesExtension", + "type_name": "DeviceCapabilitiesExtension", + "definition": { + "kind": "complexType", + "name": "DeviceCapabilitiesExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Device capabilities" + }, + { + "name": "Events", + "type": "{http://www.onvif.org/ver10/schema}EventCapabilities", + "type_name": "EventCapabilities", + "definition": { + "kind": "complexType", + "name": "EventCapabilities", + "fields": [ + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Event service URI." + }, + { + "name": "WSSubscriptionPolicySupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not WS Subscription policy is supported." + }, + { + "name": "WSPullPointSupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not WS Pull Point is supported." + }, + { + "name": "WSPausableSubscriptionManagerInterfaceSupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not WS Pausable Subscription Manager Interface is supported." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Event capabilities" + }, + { + "name": "Imaging", + "type": "{http://www.onvif.org/ver10/schema}ImagingCapabilities", + "type_name": "ImagingCapabilities", + "definition": { + "kind": "complexType", + "name": "ImagingCapabilities", + "fields": [ + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Imaging service URI." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Imaging capabilities" + }, + { + "name": "Media", + "type": "{http://www.onvif.org/ver10/schema}MediaCapabilities", + "type_name": "MediaCapabilities", + "definition": { + "kind": "complexType", + "name": "MediaCapabilities", + "fields": [ + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Media service URI." + }, + { + "name": "StreamingCapabilities", + "type": "{http://www.onvif.org/ver10/schema}RealTimeStreamingCapabilities", + "type_name": "RealTimeStreamingCapabilities", + "definition": { + "kind": "complexType", + "name": "RealTimeStreamingCapabilities", + "fields": [ + { + "name": "RTPMulticast", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not RTP multicast is supported." + }, + { + "name": "RTP_TCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not RTP over TCP is supported." + }, + { + "name": "RTP_RTSP_TCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not RTP/RTSP/TCP is supported." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RealTimeStreamingCapabilitiesExtension", + "type_name": "RealTimeStreamingCapabilitiesExtension", + "definition": { + "kind": "complexType", + "name": "RealTimeStreamingCapabilitiesExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Streaming capabilities." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MediaCapabilitiesExtension", + "type_name": "MediaCapabilitiesExtension", + "definition": { + "kind": "complexType", + "name": "MediaCapabilitiesExtension", + "fields": [ + { + "name": "ProfileCapabilities", + "type": "{http://www.onvif.org/ver10/schema}ProfileCapabilities", + "type_name": "ProfileCapabilities", + "definition": { + "kind": "complexType", + "name": "ProfileCapabilities", + "fields": [ + { + "name": "MaximumNumberOfProfiles", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of profiles." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Media capabilities" + }, + { + "name": "PTZ", + "type": "{http://www.onvif.org/ver10/schema}PTZCapabilities", + "type_name": "PTZCapabilities", + "definition": { + "kind": "complexType", + "name": "PTZCapabilities", + "fields": [ + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "PTZ service URI." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "PTZ capabilities" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}CapabilitiesExtension", + "type_name": "CapabilitiesExtension", + "definition": { + "kind": "complexType", + "name": "CapabilitiesExtension", + "fields": [ + { + "name": "DeviceIO", + "type": "{http://www.onvif.org/ver10/schema}DeviceIOCapabilities", + "type_name": "DeviceIOCapabilities", + "definition": { + "kind": "complexType", + "name": "DeviceIOCapabilities", + "fields": [ + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "VideoSources", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "VideoOutputs", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AudioSources", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AudioOutputs", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RelayOutputs", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Display", + "type": "{http://www.onvif.org/ver10/schema}DisplayCapabilities", + "type_name": "DisplayCapabilities", + "definition": { + "kind": "complexType", + "name": "DisplayCapabilities", + "fields": [ + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "FixedLayout", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indication that the SetLayout command supports only predefined layouts." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Recording", + "type": "{http://www.onvif.org/ver10/schema}RecordingCapabilities", + "type_name": "RecordingCapabilities", + "definition": { + "kind": "complexType", + "name": "RecordingCapabilities", + "fields": [ + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReceiverSource", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MediaProfileSource", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "DynamicRecordings", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "DynamicTracks", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MaxStringLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Search", + "type": "{http://www.onvif.org/ver10/schema}SearchCapabilities", + "type_name": "SearchCapabilities", + "definition": { + "kind": "complexType", + "name": "SearchCapabilities", + "fields": [ + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MetadataSearch", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "NLSearch", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates support for natural language based search." + }, + { + "name": "ImageSearch", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates support for image based search." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Replay", + "type": "{http://www.onvif.org/ver10/schema}ReplayCapabilities", + "type_name": "ReplayCapabilities", + "definition": { + "kind": "complexType", + "name": "ReplayCapabilities", + "fields": [ + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The address of the replay service." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Receiver", + "type": "{http://www.onvif.org/ver10/schema}ReceiverCapabilities", + "type_name": "ReceiverCapabilities", + "definition": { + "kind": "complexType", + "name": "ReceiverCapabilities", + "fields": [ + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The address of the receiver service." + }, + { + "name": "RTP_Multicast", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the device can receive RTP multicast streams." + }, + { + "name": "RTP_TCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the device can receive RTP/TCP streams" + }, + { + "name": "RTP_RTSP_TCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the device can receive RTP/RTSP/TCP streams." + }, + { + "name": "SupportedReceivers", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum number of receivers supported by the device." + }, + { + "name": "MaximumRTSPURILength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum allowed length for RTSP URIs." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AnalyticsDevice", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsDeviceCapabilities", + "type_name": "AnalyticsDeviceCapabilities", + "definition": { + "kind": "complexType", + "name": "AnalyticsDeviceCapabilities", + "fields": [ + { + "name": "XAddr", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleSupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Obsolete property." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsDeviceExtension", + "type_name": "AnalyticsDeviceExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsDeviceExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extensions", + "type": "{http://www.onvif.org/ver10/schema}CapabilitiesExtension2", + "type_name": "CapabilitiesExtension2", + "definition": { + "kind": "complexType", + "name": "CapabilitiesExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Capability information." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetHostname", + "port_type": "Device", + "description": "This operation is used by an endpoint to get the hostname from a device. The device shall return its hostname configurations through the GetHostname command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetHostnameRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetHostname", + "schema": { + "name": "GetHostname", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetHostnameResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetHostnameResponse", + "schema": { + "name": "GetHostnameResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "HostnameInformation", + "type": "{http://www.onvif.org/ver10/schema}HostnameInformation", + "type_name": "HostnameInformation", + "definition": { + "kind": "complexType", + "name": "HostnameInformation", + "fields": [ + { + "name": "FromDHCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the hostname has been obtained from DHCP or not." + }, + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the device hostname or an empty string if no hostname has been assigned." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}HostnameInformationExtension", + "type_name": "HostnameInformationExtension", + "definition": { + "kind": "complexType", + "name": "HostnameInformationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the hostname information." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetHostname", + "port_type": "Device", + "description": "This operation sets the hostname on a device. It shall be possible to set the device hostname configurations through the SetHostname command. A device shall accept string formated according to RFC 1123 section 2.1 or alternatively to RFC 952, other string shall be considered as invalid strings.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetHostnameRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetHostname", + "schema": { + "name": "SetHostname", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The hostname to set." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetHostnameResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetHostnameResponse", + "schema": { + "name": "SetHostnameResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetHostnameFromDHCP", + "port_type": "Device", + "description": "This operation controls whether the hostname is set manually or retrieved via DHCP.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetHostnameFromDHCPRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetHostnameFromDHCP", + "schema": { + "name": "SetHostnameFromDHCP", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "FromDHCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the hostname shall be obtained via DHCP." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetHostnameFromDHCPResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetHostnameFromDHCPResponse", + "schema": { + "name": "SetHostnameFromDHCPResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RebootNeeded", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not a reboot is required after configuration updates." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetDNS", + "port_type": "Device", + "description": "This operation gets the DNS settings from a device. The device shall return its DNS configurations through the GetDNS command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDNSRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDNS", + "schema": { + "name": "GetDNS", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDNSResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDNSResponse", + "schema": { + "name": "GetDNSResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DNSInformation", + "type": "{http://www.onvif.org/ver10/schema}DNSInformation", + "type_name": "DNSInformation", + "definition": { + "kind": "complexType", + "name": "DNSInformation", + "fields": [ + { + "name": "FromDHCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not DNS information is retrieved from DHCP." + }, + { + "name": "SearchDomain", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Search domain." + }, + { + "name": "DNSFromDHCP", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of DNS addresses received from DHCP." + }, + { + "name": "DNSManual", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of manually entered DNS addresses." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}DNSInformationExtension", + "type_name": "DNSInformationExtension", + "definition": { + "kind": "complexType", + "name": "DNSInformationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "DNS information." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetDNS", + "port_type": "Device", + "description": "This operation sets the DNS settings on a device. It shall be possible to set the device DNS configurations through the SetDNS command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetDNSRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetDNS", + "schema": { + "name": "SetDNS", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "FromDHCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicate if the DNS address is to be retrieved using DHCP." + }, + { + "name": "SearchDomain", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "DNS search domain." + }, + { + "name": "DNSManual", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "DNS address(es) set manually." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetDNSResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetDNSResponse", + "schema": { + "name": "SetDNSResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetNTP", + "port_type": "Device", + "description": "This operation gets the NTP settings from a device. If the device supports NTP, it shall be possible to get the NTP server settings through the GetNTP command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetNTPRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetNTP", + "schema": { + "name": "GetNTP", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetNTPResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetNTPResponse", + "schema": { + "name": "GetNTPResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NTPInformation", + "type": "{http://www.onvif.org/ver10/schema}NTPInformation", + "type_name": "NTPInformation", + "definition": { + "kind": "complexType", + "name": "NTPInformation", + "fields": [ + { + "name": "FromDHCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if NTP information is to be retrieved by using DHCP." + }, + { + "name": "NTPFromDHCP", + "type": "{http://www.onvif.org/ver10/schema}NetworkHost", + "type_name": "NetworkHost", + "definition": { + "kind": "complexType", + "name": "NetworkHost", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}NetworkHostType", + "type_name": "NetworkHostType", + "definition": { + "kind": "simpleType", + "name": "NetworkHostType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + }, + { + "value": "DNS" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Network host type: IPv4, IPv6 or DNS." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address." + }, + { + "name": "DNSname", + "type": "{http://www.onvif.org/ver10/schema}DNSName", + "type_name": "DNSName", + "definition": { + "kind": "simpleType", + "name": "DNSName", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "DNS name." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkHostExtension", + "type_name": "NetworkHostExtension", + "definition": { + "kind": "complexType", + "name": "NetworkHostExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of NTP addresses retrieved by using DHCP." + }, + { + "name": "NTPManual", + "type": "{http://www.onvif.org/ver10/schema}NetworkHost", + "type_name": "NetworkHost", + "definition": { + "kind": "complexType", + "name": "NetworkHost", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}NetworkHostType", + "type_name": "NetworkHostType", + "definition": { + "kind": "simpleType", + "name": "NetworkHostType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + }, + { + "value": "DNS" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Network host type: IPv4, IPv6 or DNS." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address." + }, + { + "name": "DNSname", + "type": "{http://www.onvif.org/ver10/schema}DNSName", + "type_name": "DNSName", + "definition": { + "kind": "simpleType", + "name": "DNSName", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "DNS name." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkHostExtension", + "type_name": "NetworkHostExtension", + "definition": { + "kind": "complexType", + "name": "NetworkHostExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of manually entered NTP addresses." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NTPInformationExtension", + "type_name": "NTPInformationExtension", + "definition": { + "kind": "complexType", + "name": "NTPInformationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "NTP information." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetNTP", + "port_type": "Device", + "description": "This operation sets the NTP settings on a device. If the device supports NTP, it shall be possible to set the NTP server settings through the SetNTP command. A device shall accept string formated according to RFC 1123 section 2.1 or alternatively to RFC 952, other string shall be considered as invalid strings. Changes to the NTP server list will not affect the clock mode DateTimeType. Use SetSystemDateAndTime to activate NTP operation.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetNTPRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetNTP", + "schema": { + "name": "SetNTP", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "FromDHCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicate if NTP address information is to be retrieved using DHCP." + }, + { + "name": "NTPManual", + "type": "{http://www.onvif.org/ver10/schema}NetworkHost", + "type_name": "NetworkHost", + "definition": { + "kind": "complexType", + "name": "NetworkHost", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}NetworkHostType", + "type_name": "NetworkHostType", + "definition": { + "kind": "simpleType", + "name": "NetworkHostType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + }, + { + "value": "DNS" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Network host type: IPv4, IPv6 or DNS." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address." + }, + { + "name": "DNSname", + "type": "{http://www.onvif.org/ver10/schema}DNSName", + "type_name": "DNSName", + "definition": { + "kind": "simpleType", + "name": "DNSName", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "DNS name." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkHostExtension", + "type_name": "NetworkHostExtension", + "definition": { + "kind": "complexType", + "name": "NetworkHostExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Manual NTP settings." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetNTPResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetNTPResponse", + "schema": { + "name": "SetNTPResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetDynamicDNS", + "port_type": "Device", + "description": "This operation gets the dynamic DNS settings from a device. If the device supports dynamic DNS as specified in [RFC 2136] and [RFC 4702], it shall be possible to get the type, name and TTL through the GetDynamicDNS command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDynamicDNSRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDynamicDNS", + "schema": { + "name": "GetDynamicDNS", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDynamicDNSResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDynamicDNSResponse", + "schema": { + "name": "GetDynamicDNSResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DynamicDNSInformation", + "type": "{http://www.onvif.org/ver10/schema}DynamicDNSInformation", + "type_name": "DynamicDNSInformation", + "definition": { + "kind": "complexType", + "name": "DynamicDNSInformation", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}DynamicDNSType", + "type_name": "DynamicDNSType", + "definition": { + "kind": "simpleType", + "name": "DynamicDNSType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "NoUpdate" + }, + { + "value": "ClientUpdates" + }, + { + "value": "ServerUpdates" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Dynamic DNS type." + }, + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}DNSName", + "type_name": "DNSName", + "definition": { + "kind": "simpleType", + "name": "DNSName", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "DNS name." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Time to live." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}DynamicDNSInformationExtension", + "type_name": "DynamicDNSInformationExtension", + "definition": { + "kind": "complexType", + "name": "DynamicDNSInformationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Dynamic DNS information." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetDynamicDNS", + "port_type": "Device", + "description": "This operation sets the dynamic DNS settings on a device. If the device supports dynamic DNS as specified in [RFC 2136] and [RFC 4702], it shall be possible to set the type, name and TTL through the SetDynamicDNS command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetDynamicDNSRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetDynamicDNS", + "schema": { + "name": "SetDynamicDNS", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}DynamicDNSType", + "type_name": "DynamicDNSType", + "definition": { + "kind": "simpleType", + "name": "DynamicDNSType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "NoUpdate" + }, + { + "value": "ClientUpdates" + }, + { + "value": "ServerUpdates" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Dynamic DNS type." + }, + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}DNSName", + "type_name": "DNSName", + "definition": { + "kind": "simpleType", + "name": "DNSName", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "DNS name." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "DNS record time to live." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetDynamicDNSResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetDynamicDNSResponse", + "schema": { + "name": "SetDynamicDNSResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetNetworkInterfaces", + "port_type": "Device", + "description": "This operation gets the network interface configuration from a device. The device shall support return of network interface configuration settings as defined by the NetworkInterface type through the GetNetworkInterfaces command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetNetworkInterfacesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetNetworkInterfaces", + "schema": { + "name": "GetNetworkInterfaces", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetNetworkInterfacesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetNetworkInterfacesResponse", + "schema": { + "name": "GetNetworkInterfacesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NetworkInterfaces", + "type": "{http://www.onvif.org/ver10/schema}NetworkInterface", + "type_name": "NetworkInterface", + "definition": { + "kind": "complexType", + "name": "NetworkInterface", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not an interface is enabled." + }, + { + "name": "Info", + "type": "{http://www.onvif.org/ver10/schema}NetworkInterfaceInfo", + "type_name": "NetworkInterfaceInfo", + "definition": { + "kind": "complexType", + "name": "NetworkInterfaceInfo", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Network interface name, for example eth0." + }, + { + "name": "HwAddress", + "type": "{http://www.onvif.org/ver10/schema}HwAddress", + "type_name": "HwAddress", + "definition": { + "kind": "simpleType", + "name": "HwAddress", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Network interface MAC address." + }, + { + "name": "MTU", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum transmission unit." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Network interface information" + }, + { + "name": "Link", + "type": "{http://www.onvif.org/ver10/schema}NetworkInterfaceLink", + "type_name": "NetworkInterfaceLink", + "definition": { + "kind": "complexType", + "name": "NetworkInterfaceLink", + "fields": [ + { + "name": "AdminSettings", + "type": "{http://www.onvif.org/ver10/schema}NetworkInterfaceConnectionSetting", + "type_name": "NetworkInterfaceConnectionSetting", + "definition": { + "kind": "complexType", + "name": "NetworkInterfaceConnectionSetting", + "fields": [ + { + "name": "AutoNegotiation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Auto negotiation on/off." + }, + { + "name": "Speed", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Speed." + }, + { + "name": "Duplex", + "type": "{http://www.onvif.org/ver10/schema}Duplex", + "type_name": "Duplex", + "definition": { + "kind": "simpleType", + "name": "Duplex", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Full" + }, + { + "value": "Half" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Duplex type, Half or Full." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured link settings." + }, + { + "name": "OperSettings", + "type": "{http://www.onvif.org/ver10/schema}NetworkInterfaceConnectionSetting", + "type_name": "NetworkInterfaceConnectionSetting", + "definition": { + "kind": "complexType", + "name": "NetworkInterfaceConnectionSetting", + "fields": [ + { + "name": "AutoNegotiation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Auto negotiation on/off." + }, + { + "name": "Speed", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Speed." + }, + { + "name": "Duplex", + "type": "{http://www.onvif.org/ver10/schema}Duplex", + "type_name": "Duplex", + "definition": { + "kind": "simpleType", + "name": "Duplex", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Full" + }, + { + "value": "Half" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Duplex type, Half or Full." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current active link settings." + }, + { + "name": "InterfaceType", + "type": "{http://www.onvif.org/ver10/schema}IANA-IfTypes", + "type_name": "IANA-IfTypes", + "definition": { + "kind": "simpleType", + "name": "IANA-IfTypes", + "base": "{http://www.w3.org/2001/XMLSchema}int" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Integer indicating interface type, for example: 6 is ethernet." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Link configuration." + }, + { + "name": "IPv4", + "type": "{http://www.onvif.org/ver10/schema}IPv4NetworkInterface", + "type_name": "IPv4NetworkInterface", + "definition": { + "kind": "complexType", + "name": "IPv4NetworkInterface", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not IPv4 is enabled." + }, + { + "name": "Config", + "type": "{http://www.onvif.org/ver10/schema}IPv4Configuration", + "type_name": "IPv4Configuration", + "definition": { + "kind": "complexType", + "name": "IPv4Configuration", + "fields": [ + { + "name": "Manual", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv4Address", + "type_name": "PrefixedIPv4Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv4Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of manually added IPv4 addresses." + }, + { + "name": "LinkLocal", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv4Address", + "type_name": "PrefixedIPv4Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv4Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Link local address." + }, + { + "name": "FromDHCP", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv4Address", + "type_name": "PrefixedIPv4Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv4Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address configured by using DHCP." + }, + { + "name": "DHCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not DHCP is used." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 configuration." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 network interface configuration." + }, + { + "name": "IPv6", + "type": "{http://www.onvif.org/ver10/schema}IPv6NetworkInterface", + "type_name": "IPv6NetworkInterface", + "definition": { + "kind": "complexType", + "name": "IPv6NetworkInterface", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not IPv6 is enabled." + }, + { + "name": "Config", + "type": "{http://www.onvif.org/ver10/schema}IPv6Configuration", + "type_name": "IPv6Configuration", + "definition": { + "kind": "complexType", + "name": "IPv6Configuration", + "fields": [ + { + "name": "AcceptRouterAdvert", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether router advertisement is used." + }, + { + "name": "DHCP", + "type": "{http://www.onvif.org/ver10/schema}IPv6DHCPConfiguration", + "type_name": "IPv6DHCPConfiguration", + "definition": { + "kind": "simpleType", + "name": "IPv6DHCPConfiguration", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Auto" + }, + { + "value": "Stateful" + }, + { + "value": "Stateless" + }, + { + "value": "Off" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "DHCP configuration." + }, + { + "name": "Manual", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv6Address", + "type_name": "PrefixedIPv6Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv6Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of manually entered IPv6 addresses." + }, + { + "name": "LinkLocal", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv6Address", + "type_name": "PrefixedIPv6Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv6Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of link local IPv6 addresses." + }, + { + "name": "FromDHCP", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv6Address", + "type_name": "PrefixedIPv6Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv6Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of IPv6 addresses configured by using DHCP." + }, + { + "name": "FromRA", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv6Address", + "type_name": "PrefixedIPv6Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv6Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of IPv6 addresses configured by using router advertisement." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}IPv6ConfigurationExtension", + "type_name": "IPv6ConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "IPv6ConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 configuration." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 network interface configuration." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkInterfaceExtension", + "type_name": "NetworkInterfaceExtension", + "definition": { + "kind": "complexType", + "name": "NetworkInterfaceExtension", + "fields": [ + { + "name": "InterfaceType", + "type": "{http://www.onvif.org/ver10/schema}IANA-IfTypes", + "type_name": "IANA-IfTypes", + "definition": { + "kind": "simpleType", + "name": "IANA-IfTypes", + "base": "{http://www.w3.org/2001/XMLSchema}int" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Dot3", + "type": "{http://www.onvif.org/ver10/schema}Dot3Configuration", + "type_name": "Dot3Configuration", + "definition": { + "kind": "complexType", + "name": "Dot3Configuration", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Extension point prepared for future 802.3 configuration." + }, + { + "name": "Dot11", + "type": "{http://www.onvif.org/ver10/schema}Dot11Configuration", + "type_name": "Dot11Configuration", + "definition": { + "kind": "complexType", + "name": "Dot11Configuration", + "fields": [ + { + "name": "SSID", + "type": "{http://www.onvif.org/ver10/schema}Dot11SSIDType", + "type_name": "Dot11SSIDType", + "definition": { + "kind": "simpleType", + "name": "Dot11SSIDType", + "base": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "minLength": "1", + "maxLength": "32" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}Dot11StationMode", + "type_name": "Dot11StationMode", + "definition": { + "kind": "simpleType", + "name": "Dot11StationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Ad-hoc" + }, + { + "value": "Infrastructure" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Alias", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Priority", + "type": "{http://www.onvif.org/ver10/schema}NetworkInterfaceConfigPriority", + "type_name": "NetworkInterfaceConfigPriority", + "definition": { + "kind": "simpleType", + "name": "NetworkInterfaceConfigPriority", + "base": "{http://www.w3.org/2001/XMLSchema}integer", + "minInclusive": "0", + "maxInclusive": "31" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Security", + "type": "{http://www.onvif.org/ver10/schema}Dot11SecurityConfiguration", + "type_name": "Dot11SecurityConfiguration", + "definition": { + "kind": "complexType", + "name": "Dot11SecurityConfiguration", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}Dot11SecurityMode", + "type_name": "Dot11SecurityMode", + "definition": { + "kind": "simpleType", + "name": "Dot11SecurityMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "None" + }, + { + "value": "WEP" + }, + { + "value": "PSK" + }, + { + "value": "Dot1X" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Algorithm", + "type": "{http://www.onvif.org/ver10/schema}Dot11Cipher", + "type_name": "Dot11Cipher", + "definition": { + "kind": "simpleType", + "name": "Dot11Cipher", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "CCMP" + }, + { + "value": "TKIP" + }, + { + "value": "Any" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "PSK", + "type": "{http://www.onvif.org/ver10/schema}Dot11PSKSet", + "type_name": "Dot11PSKSet", + "definition": { + "kind": "complexType", + "name": "Dot11PSKSet", + "fields": [ + { + "name": "Key", + "type": "{http://www.onvif.org/ver10/schema}Dot11PSK", + "type_name": "Dot11PSK", + "definition": { + "kind": "simpleType", + "name": "Dot11PSK", + "base": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "length": "32" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "According to IEEE802.11-2007 H.4.1 the RSNA PSK consists of 256 bits, or 64 octets when represented in hex
\n\t\t\t\t\tEither Key or Passphrase shall be given, if both are supplied Key shall be used by the device and Passphrase ignored." + }, + { + "name": "Passphrase", + "type": "{http://www.onvif.org/ver10/schema}Dot11PSKPassphrase", + "type_name": "Dot11PSKPassphrase", + "definition": { + "kind": "simpleType", + "name": "Dot11PSKPassphrase", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "[ -~]{8,63}" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "According to IEEE802.11-2007 H.4.1 a pass-phrase is a sequence of between 8 and 63 ASCII-encoded characters and\n\t\t\t\t\teach character in the pass-phrase must have an encoding in the range of 32 to 126 (decimal),inclusive.
\n\t\t\t\t\tIf only Passphrase is supplied the Key shall be derived using the algorithm described in IEEE802.11-2007 section H.4" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}Dot11PSKSetExtension", + "type_name": "Dot11PSKSetExtension", + "definition": { + "kind": "complexType", + "name": "Dot11PSKSetExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Dot1X", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}Dot11SecurityConfigurationExtension", + "type_name": "Dot11SecurityConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "Dot11SecurityConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkInterfaceExtension2", + "type_name": "NetworkInterfaceExtension2", + "definition": { + "kind": "complexType", + "name": "NetworkInterfaceExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of network interfaces." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetNetworkInterfaces", + "port_type": "Device", + "description": "This operation sets the network interface configuration on a device. The device shall support network configuration of supported network interfaces through the SetNetworkInterfaces command. For interoperability with a client unaware of the IEEE 802.11 extension a device shall retain its IEEE 802.11 configuration if the IEEE 802.11 configuration element isn’t present in the request.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetNetworkInterfacesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetNetworkInterfaces", + "schema": { + "name": "SetNetworkInterfaces", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "InterfaceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Symbolic network interface name." + }, + { + "name": "NetworkInterface", + "type": "{http://www.onvif.org/ver10/schema}NetworkInterfaceSetConfiguration", + "type_name": "NetworkInterfaceSetConfiguration", + "definition": { + "kind": "complexType", + "name": "NetworkInterfaceSetConfiguration", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not an interface is enabled." + }, + { + "name": "Link", + "type": "{http://www.onvif.org/ver10/schema}NetworkInterfaceConnectionSetting", + "type_name": "NetworkInterfaceConnectionSetting", + "definition": { + "kind": "complexType", + "name": "NetworkInterfaceConnectionSetting", + "fields": [ + { + "name": "AutoNegotiation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Auto negotiation on/off." + }, + { + "name": "Speed", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Speed." + }, + { + "name": "Duplex", + "type": "{http://www.onvif.org/ver10/schema}Duplex", + "type_name": "Duplex", + "definition": { + "kind": "simpleType", + "name": "Duplex", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Full" + }, + { + "value": "Half" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Duplex type, Half or Full." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Link configuration." + }, + { + "name": "MTU", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum transmission unit." + }, + { + "name": "IPv4", + "type": "{http://www.onvif.org/ver10/schema}IPv4NetworkInterfaceSetConfiguration", + "type_name": "IPv4NetworkInterfaceSetConfiguration", + "definition": { + "kind": "complexType", + "name": "IPv4NetworkInterfaceSetConfiguration", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not IPv4 is enabled." + }, + { + "name": "Manual", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv4Address", + "type_name": "PrefixedIPv4Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv4Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of manually added IPv4 addresses." + }, + { + "name": "DHCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not DHCP is used." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 network interface configuration." + }, + { + "name": "IPv6", + "type": "{http://www.onvif.org/ver10/schema}IPv6NetworkInterfaceSetConfiguration", + "type_name": "IPv6NetworkInterfaceSetConfiguration", + "definition": { + "kind": "complexType", + "name": "IPv6NetworkInterfaceSetConfiguration", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not IPv6 is enabled." + }, + { + "name": "AcceptRouterAdvert", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether router advertisement is used." + }, + { + "name": "Manual", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv6Address", + "type_name": "PrefixedIPv6Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv6Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of manually added IPv6 addresses." + }, + { + "name": "DHCP", + "type": "{http://www.onvif.org/ver10/schema}IPv6DHCPConfiguration", + "type_name": "IPv6DHCPConfiguration", + "definition": { + "kind": "simpleType", + "name": "IPv6DHCPConfiguration", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Auto" + }, + { + "value": "Stateful" + }, + { + "value": "Stateless" + }, + { + "value": "Off" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "DHCP configuration." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 network interface configuration." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkInterfaceSetConfigurationExtension", + "type_name": "NetworkInterfaceSetConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "NetworkInterfaceSetConfigurationExtension", + "fields": [ + { + "name": "Dot3", + "type": "{http://www.onvif.org/ver10/schema}Dot3Configuration", + "type_name": "Dot3Configuration", + "definition": { + "kind": "complexType", + "name": "Dot3Configuration", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Dot11", + "type": "{http://www.onvif.org/ver10/schema}Dot11Configuration", + "type_name": "Dot11Configuration", + "definition": { + "kind": "complexType", + "name": "Dot11Configuration", + "fields": [ + { + "name": "SSID", + "type": "{http://www.onvif.org/ver10/schema}Dot11SSIDType", + "type_name": "Dot11SSIDType", + "definition": { + "kind": "simpleType", + "name": "Dot11SSIDType", + "base": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "minLength": "1", + "maxLength": "32" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}Dot11StationMode", + "type_name": "Dot11StationMode", + "definition": { + "kind": "simpleType", + "name": "Dot11StationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Ad-hoc" + }, + { + "value": "Infrastructure" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Alias", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Priority", + "type": "{http://www.onvif.org/ver10/schema}NetworkInterfaceConfigPriority", + "type_name": "NetworkInterfaceConfigPriority", + "definition": { + "kind": "simpleType", + "name": "NetworkInterfaceConfigPriority", + "base": "{http://www.w3.org/2001/XMLSchema}integer", + "minInclusive": "0", + "maxInclusive": "31" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Security", + "type": "{http://www.onvif.org/ver10/schema}Dot11SecurityConfiguration", + "type_name": "Dot11SecurityConfiguration", + "definition": { + "kind": "complexType", + "name": "Dot11SecurityConfiguration", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}Dot11SecurityMode", + "type_name": "Dot11SecurityMode", + "definition": { + "kind": "simpleType", + "name": "Dot11SecurityMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "None" + }, + { + "value": "WEP" + }, + { + "value": "PSK" + }, + { + "value": "Dot1X" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Algorithm", + "type": "{http://www.onvif.org/ver10/schema}Dot11Cipher", + "type_name": "Dot11Cipher", + "definition": { + "kind": "simpleType", + "name": "Dot11Cipher", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "CCMP" + }, + { + "value": "TKIP" + }, + { + "value": "Any" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "PSK", + "type": "{http://www.onvif.org/ver10/schema}Dot11PSKSet", + "type_name": "Dot11PSKSet", + "definition": { + "kind": "complexType", + "name": "Dot11PSKSet", + "fields": [ + { + "name": "Key", + "type": "{http://www.onvif.org/ver10/schema}Dot11PSK", + "type_name": "Dot11PSK", + "definition": { + "kind": "simpleType", + "name": "Dot11PSK", + "base": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "length": "32" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "According to IEEE802.11-2007 H.4.1 the RSNA PSK consists of 256 bits, or 64 octets when represented in hex
\n\t\t\t\t\tEither Key or Passphrase shall be given, if both are supplied Key shall be used by the device and Passphrase ignored." + }, + { + "name": "Passphrase", + "type": "{http://www.onvif.org/ver10/schema}Dot11PSKPassphrase", + "type_name": "Dot11PSKPassphrase", + "definition": { + "kind": "simpleType", + "name": "Dot11PSKPassphrase", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "[ -~]{8,63}" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "According to IEEE802.11-2007 H.4.1 a pass-phrase is a sequence of between 8 and 63 ASCII-encoded characters and\n\t\t\t\t\teach character in the pass-phrase must have an encoding in the range of 32 to 126 (decimal),inclusive.
\n\t\t\t\t\tIf only Passphrase is supplied the Key shall be derived using the algorithm described in IEEE802.11-2007 section H.4" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}Dot11PSKSetExtension", + "type_name": "Dot11PSKSetExtension", + "definition": { + "kind": "complexType", + "name": "Dot11PSKSetExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Dot1X", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}Dot11SecurityConfigurationExtension", + "type_name": "Dot11SecurityConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "Dot11SecurityConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkInterfaceSetConfigurationExtension2", + "type_name": "NetworkInterfaceSetConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "NetworkInterfaceSetConfigurationExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Network interface name." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetNetworkInterfacesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetNetworkInterfacesResponse", + "schema": { + "name": "SetNetworkInterfacesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RebootNeeded", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not a reboot is required after configuration updates.\n\t\t\t\t\t\t\t\t\tIf a device responds with RebootNeeded set to false, the device can be reached\n\t\t\t\t\t\t\t\t\tvia the new IP address without further action. A client should be aware that a device\n\t\t\t\t\t\t\t\t\tmay not be responsive for a short period of time until it signals availability at\n\t\t\t\t\t\t\t\t\tthe new address via the discovery Hello messages.\n\t\t\t\t\t\t\t\t\tIf a device responds with RebootNeeded set to true, it will be further available under\n\t\t\t\t\t\t\t\t\tits previous IP address. The settings will only be activated when the device is\n\t\t\t\t\t\t\t\t\trebooted via the SystemReboot command." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetNetworkProtocols", + "port_type": "Device", + "description": "This operation gets defined network protocols from a device. The device shall support the GetNetworkProtocols command returning configured network protocols.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetNetworkProtocolsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetNetworkProtocols", + "schema": { + "name": "GetNetworkProtocols", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetNetworkProtocolsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetNetworkProtocolsResponse", + "schema": { + "name": "GetNetworkProtocolsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NetworkProtocols", + "type": "{http://www.onvif.org/ver10/schema}NetworkProtocol", + "type_name": "NetworkProtocol", + "definition": { + "kind": "complexType", + "name": "NetworkProtocol", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}NetworkProtocolType", + "type_name": "NetworkProtocolType", + "definition": { + "kind": "simpleType", + "name": "NetworkProtocolType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "HTTP" + }, + { + "value": "HTTPS" + }, + { + "value": "RTSP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Network protocol type string." + }, + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the protocol is enabled or not." + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "The port that is used by the protocol." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkProtocolExtension", + "type_name": "NetworkProtocolExtension", + "definition": { + "kind": "complexType", + "name": "NetworkProtocolExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains an array of defined protocols supported by the device. There are three protocols defined; HTTP, HTTPS and RTSP. The following parameters can be retrieved for each protocol: port and enable/disable." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetNetworkProtocols", + "port_type": "Device", + "description": "This operation configures defined network protocols on a device. The device shall support configuration of defined network protocols through the SetNetworkProtocols command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetNetworkProtocolsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetNetworkProtocols", + "schema": { + "name": "SetNetworkProtocols", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NetworkProtocols", + "type": "{http://www.onvif.org/ver10/schema}NetworkProtocol", + "type_name": "NetworkProtocol", + "definition": { + "kind": "complexType", + "name": "NetworkProtocol", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}NetworkProtocolType", + "type_name": "NetworkProtocolType", + "definition": { + "kind": "simpleType", + "name": "NetworkProtocolType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "HTTP" + }, + { + "value": "HTTPS" + }, + { + "value": "RTSP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Network protocol type string." + }, + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the protocol is enabled or not." + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "The port that is used by the protocol." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkProtocolExtension", + "type_name": "NetworkProtocolExtension", + "definition": { + "kind": "complexType", + "name": "NetworkProtocolExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Configures one or more defined network protocols supported by the device. There are currently three protocols defined; HTTP, HTTPS and RTSP. The following parameters can be set for each protocol: port and enable/disable." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetNetworkProtocolsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetNetworkProtocolsResponse", + "schema": { + "name": "SetNetworkProtocolsResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetNetworkDefaultGateway", + "port_type": "Device", + "description": "This operation gets the default gateway settings from a device. The device shall support the GetNetworkDefaultGateway command returning configured default gateway address(es).", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetNetworkDefaultGatewayRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetNetworkDefaultGateway", + "schema": { + "name": "GetNetworkDefaultGateway", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetNetworkDefaultGatewayResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetNetworkDefaultGatewayResponse", + "schema": { + "name": "GetNetworkDefaultGatewayResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NetworkGateway", + "type": "{http://www.onvif.org/ver10/schema}NetworkGateway", + "type_name": "NetworkGateway", + "definition": { + "kind": "complexType", + "name": "NetworkGateway", + "fields": [ + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "IPv4 address string." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "IPv6 address string." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Gets the default IPv4 and IPv6 gateway settings from the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetNetworkDefaultGateway", + "port_type": "Device", + "description": "This operation sets the default gateway settings on a device. The device shall support configuration of default gateway through the SetNetworkDefaultGateway command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetNetworkDefaultGatewayRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetNetworkDefaultGateway", + "schema": { + "name": "SetNetworkDefaultGateway", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Sets IPv4 gateway address used as default setting." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Sets IPv6 gateway address used as default setting." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetNetworkDefaultGatewayResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetNetworkDefaultGatewayResponse", + "schema": { + "name": "SetNetworkDefaultGatewayResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetZeroConfiguration", + "port_type": "Device", + "description": "This operation gets the zero-configuration from a device. If the device supports dynamic IP configuration according to [RFC3927], it shall support the return of IPv4 zero configuration address and status through the GetZeroConfiguration command. Devices supporting zero configuration on more than one interface shall use the extension to list the additional interface settings.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetZeroConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetZeroConfiguration", + "schema": { + "name": "GetZeroConfiguration", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetZeroConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetZeroConfigurationResponse", + "schema": { + "name": "GetZeroConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ZeroConfiguration", + "type": "{http://www.onvif.org/ver10/schema}NetworkZeroConfiguration", + "type_name": "NetworkZeroConfiguration", + "definition": { + "kind": "complexType", + "name": "NetworkZeroConfiguration", + "fields": [ + { + "name": "InterfaceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique identifier of network interface." + }, + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the zero-configuration is enabled or not." + }, + { + "name": "Addresses", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The zero-configuration IPv4 address(es)" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkZeroConfigurationExtension", + "type_name": "NetworkZeroConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "NetworkZeroConfigurationExtension", + "fields": [ + { + "name": "Additional", + "type": "{http://www.onvif.org/ver10/schema}NetworkZeroConfiguration", + "type_name": "NetworkZeroConfiguration", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional array holding the configuration for the second and possibly further interfaces." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}NetworkZeroConfigurationExtension2", + "type_name": "NetworkZeroConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "NetworkZeroConfigurationExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the zero-configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetZeroConfiguration", + "port_type": "Device", + "description": "This operation sets the zero-configuration. Use GetCapalities to get if zero-zero-configuration is supported or not.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetZeroConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetZeroConfiguration", + "schema": { + "name": "SetZeroConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "InterfaceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique identifier referencing the physical interface." + }, + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies if the zero-configuration should be enabled or not." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetZeroConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetZeroConfigurationResponse", + "schema": { + "name": "SetZeroConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetIPAddressFilter", + "port_type": "Device", + "description": "This operation gets the IP address filter settings from a device. If the device supports device access control based on IP filtering rules (denied or accepted ranges of IP addresses), the device shall support the GetIPAddressFilter command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetIPAddressFilterRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetIPAddressFilter", + "schema": { + "name": "GetIPAddressFilter", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetIPAddressFilterResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetIPAddressFilterResponse", + "schema": { + "name": "GetIPAddressFilterResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "IPAddressFilter", + "type": "{http://www.onvif.org/ver10/schema}IPAddressFilter", + "type_name": "IPAddressFilter", + "definition": { + "kind": "complexType", + "name": "IPAddressFilter", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPAddressFilterType", + "type_name": "IPAddressFilterType", + "definition": { + "kind": "simpleType", + "name": "IPAddressFilterType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Allow" + }, + { + "value": "Deny" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv4Address", + "type_name": "PrefixedIPv4Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv4Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv6Address", + "type_name": "PrefixedIPv6Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv6Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}IPAddressFilterExtension", + "type_name": "IPAddressFilterExtension", + "definition": { + "kind": "complexType", + "name": "IPAddressFilterExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetIPAddressFilter", + "port_type": "Device", + "description": "This operation sets the IP address filter settings on a device. If the device supports device access control based on IP filtering rules (denied or accepted ranges of IP addresses), the device shall support configuration of IP filtering rules through the SetIPAddressFilter command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetIPAddressFilterRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetIPAddressFilter", + "schema": { + "name": "SetIPAddressFilter", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "IPAddressFilter", + "type": "{http://www.onvif.org/ver10/schema}IPAddressFilter", + "type_name": "IPAddressFilter", + "definition": { + "kind": "complexType", + "name": "IPAddressFilter", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPAddressFilterType", + "type_name": "IPAddressFilterType", + "definition": { + "kind": "simpleType", + "name": "IPAddressFilterType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Allow" + }, + { + "value": "Deny" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv4Address", + "type_name": "PrefixedIPv4Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv4Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv6Address", + "type_name": "PrefixedIPv6Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv6Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}IPAddressFilterExtension", + "type_name": "IPAddressFilterExtension", + "definition": { + "kind": "complexType", + "name": "IPAddressFilterExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetIPAddressFilterResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetIPAddressFilterResponse", + "schema": { + "name": "SetIPAddressFilterResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "AddIPAddressFilter", + "port_type": "Device", + "description": "This operation adds an IP filter address to a device. If the device supports device access control based on IP filtering rules (denied or accepted ranges of IP addresses), the device shall support adding of IP filtering addresses through the AddIPAddressFilter command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}AddIPAddressFilterRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}AddIPAddressFilter", + "schema": { + "name": "AddIPAddressFilter", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "IPAddressFilter", + "type": "{http://www.onvif.org/ver10/schema}IPAddressFilter", + "type_name": "IPAddressFilter", + "definition": { + "kind": "complexType", + "name": "IPAddressFilter", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPAddressFilterType", + "type_name": "IPAddressFilterType", + "definition": { + "kind": "simpleType", + "name": "IPAddressFilterType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Allow" + }, + { + "value": "Deny" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv4Address", + "type_name": "PrefixedIPv4Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv4Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv6Address", + "type_name": "PrefixedIPv6Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv6Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}IPAddressFilterExtension", + "type_name": "IPAddressFilterExtension", + "definition": { + "kind": "complexType", + "name": "IPAddressFilterExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}AddIPAddressFilterResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}AddIPAddressFilterResponse", + "schema": { + "name": "AddIPAddressFilterResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "RemoveIPAddressFilter", + "port_type": "Device", + "description": "This operation deletes an IP filter address from a device. If the device supports device access control based on IP filtering rules (denied or accepted ranges of IP addresses), the device shall support deletion of IP filtering addresses through the RemoveIPAddressFilter command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}RemoveIPAddressFilterRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}RemoveIPAddressFilter", + "schema": { + "name": "RemoveIPAddressFilter", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "IPAddressFilter", + "type": "{http://www.onvif.org/ver10/schema}IPAddressFilter", + "type_name": "IPAddressFilter", + "definition": { + "kind": "complexType", + "name": "IPAddressFilter", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPAddressFilterType", + "type_name": "IPAddressFilterType", + "definition": { + "kind": "simpleType", + "name": "IPAddressFilterType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Allow" + }, + { + "value": "Deny" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv4Address", + "type_name": "PrefixedIPv4Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv4Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}PrefixedIPv6Address", + "type_name": "PrefixedIPv6Address", + "definition": { + "kind": "complexType", + "name": "PrefixedIPv6Address", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + }, + { + "name": "PrefixLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix/submask length" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}IPAddressFilterExtension", + "type_name": "IPAddressFilterExtension", + "definition": { + "kind": "complexType", + "name": "IPAddressFilterExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}RemoveIPAddressFilterResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}RemoveIPAddressFilterResponse", + "schema": { + "name": "RemoveIPAddressFilterResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetAccessPolicy", + "port_type": "Device", + "description": "Access to different services and sub-sets of services should be subject to access control. The WS-Security framework gives the prerequisite for end-point authentication. Authorization decisions can then be taken using an access security policy. This standard does not mandate any particular policy description format or security policy but this is up to the device manufacturer or system provider to choose policy and policy description format of choice. However, an access policy (in arbitrary format) can be requested using this command. If the device supports access policy settings based on WS-Security authentication, then the device shall support this command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetAccessPolicyRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetAccessPolicy", + "schema": { + "name": "GetAccessPolicy", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetAccessPolicyResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetAccessPolicyResponse", + "schema": { + "name": "GetAccessPolicyResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PolicyFile", + "type": "{http://www.onvif.org/ver10/schema}BinaryData", + "type_name": "BinaryData", + "definition": { + "kind": "complexType", + "name": "BinaryData", + "fields": [ + { + "name": "Data", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded binary data." + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetAccessPolicy", + "port_type": "Device", + "description": "This command sets the device access security policy (for more details on the access security policy see the Get command). If the device supports access policy settings based on WS-Security authentication, then the device shall support this command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetAccessPolicyRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetAccessPolicy", + "schema": { + "name": "SetAccessPolicy", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PolicyFile", + "type": "{http://www.onvif.org/ver10/schema}BinaryData", + "type_name": "BinaryData", + "definition": { + "kind": "complexType", + "name": "BinaryData", + "fields": [ + { + "name": "Data", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded binary data." + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetAccessPolicyResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetAccessPolicyResponse", + "schema": { + "name": "SetAccessPolicyResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetRelayOutputs", + "port_type": "Device", + "description": "This operation gets a list of all available relay outputs and their settings. This method has been depricated with version 2.0. Refer to the DeviceIO service.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetRelayOutputsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetRelayOutputs", + "schema": { + "name": "GetRelayOutputs", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetRelayOutputsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetRelayOutputsResponse", + "schema": { + "name": "GetRelayOutputsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RelayOutputs", + "type": "{http://www.onvif.org/ver10/schema}RelayOutput", + "type_name": "RelayOutput", + "definition": { + "kind": "complexType", + "name": "RelayOutput", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Properties", + "type": "{http://www.onvif.org/ver10/schema}RelayOutputSettings", + "type_name": "RelayOutputSettings", + "definition": { + "kind": "complexType", + "name": "RelayOutputSettings", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RelayMode", + "type_name": "RelayMode", + "definition": { + "kind": "simpleType", + "name": "RelayMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Monostable" + }, + { + "value": "Bistable" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "'Bistable' or 'Monostable'\n\t\t\t\t\t
    \n\t\t\t\t\t\t\t
  • Bistable - After setting the state, the relay remains in this state.
    • \n\t\t\t\t\t\t\t
  • Monostable - After setting the state, the relay returns to its idle state after the specified time.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "DelayTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Time after which the relay returns to its idle state if it is in monostable mode. If the Mode field is set to bistable mode the value of the parameter can be ignored." + }, + { + "name": "IdleState", + "type": "{http://www.onvif.org/ver10/schema}RelayIdleState", + "type_name": "RelayIdleState", + "definition": { + "kind": "simpleType", + "name": "RelayIdleState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "closed" + }, + { + "value": "open" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "'open' or 'closed'\n\t\t\t
    \n\t\t\t\t\t\t\t
  • 'open' means that the relay is open when the relay state is set to 'inactive' through the trigger command and closed when the state is set to 'active' through the same command.
    • \n\t\t\t\t\t\t\t
  • 'closed' means that the relay is closed when the relay state is set to 'inactive' through the trigger command and open when the state is set to 'active' through the same command.
    • \n\t\t\t\t\t\t
" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetRelayOutputSettings", + "port_type": "Device", + "description": "This operation sets the settings of a relay output. This method has been depricated with version 2.0. Refer to the DeviceIO service.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetRelayOutputSettingsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetRelayOutputSettings", + "schema": { + "name": "SetRelayOutputSettings", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RelayOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Properties", + "type": "{http://www.onvif.org/ver10/schema}RelayOutputSettings", + "type_name": "RelayOutputSettings", + "definition": { + "kind": "complexType", + "name": "RelayOutputSettings", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RelayMode", + "type_name": "RelayMode", + "definition": { + "kind": "simpleType", + "name": "RelayMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Monostable" + }, + { + "value": "Bistable" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "'Bistable' or 'Monostable'\n\t\t\t\t\t
    \n\t\t\t\t\t\t\t
  • Bistable - After setting the state, the relay remains in this state.
    • \n\t\t\t\t\t\t\t
  • Monostable - After setting the state, the relay returns to its idle state after the specified time.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "DelayTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Time after which the relay returns to its idle state if it is in monostable mode. If the Mode field is set to bistable mode the value of the parameter can be ignored." + }, + { + "name": "IdleState", + "type": "{http://www.onvif.org/ver10/schema}RelayIdleState", + "type_name": "RelayIdleState", + "definition": { + "kind": "simpleType", + "name": "RelayIdleState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "closed" + }, + { + "value": "open" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "'open' or 'closed'\n\t\t\t
    \n\t\t\t\t\t\t\t
  • 'open' means that the relay is open when the relay state is set to 'inactive' through the trigger command and closed when the state is set to 'active' through the same command.
    • \n\t\t\t\t\t\t\t
  • 'closed' means that the relay is closed when the relay state is set to 'inactive' through the trigger command and open when the state is set to 'active' through the same command.
    • \n\t\t\t\t\t\t
" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetRelayOutputSettingsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetRelayOutputSettingsResponse", + "schema": { + "name": "SetRelayOutputSettingsResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetRelayOutputState", + "port_type": "Device", + "description": "This operation sets the state of a relay output. This method has been depricated with version 2.0. Refer to the DeviceIO service.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetRelayOutputStateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetRelayOutputState", + "schema": { + "name": "SetRelayOutputState", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RelayOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "LogicalState", + "type": "{http://www.onvif.org/ver10/schema}RelayLogicalState", + "type_name": "RelayLogicalState", + "definition": { + "kind": "simpleType", + "name": "RelayLogicalState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "active" + }, + { + "value": "inactive" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetRelayOutputStateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetRelayOutputStateResponse", + "schema": { + "name": "SetRelayOutputStateResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SendAuxiliaryCommand", + "port_type": "Device", + "description": "Manage auxiliary commands supported by a device, such as controlling an Infrared (IR) lamp, a heater or a wiper or a thermometer that is connected to the device. The supported commands can be retrieved via the AuxiliaryCommands capability. Although the name of the auxiliary commands can be freely defined, commands starting with the prefix tt: are reserved to define frequently used commands and these reserved commands shall all share the \"tt:command|parameter\" syntax. tt:Wiper|On – Request to start the wiper. tt:Wiper|Off – Request to stop the wiper. tt:Washer|On – Request to start the washer. tt:Washer|Off – Request to stop the washer. tt:WashingProcedure|On – Request to start the washing procedure. tt: WashingProcedure |Off – Request to stop the washing procedure. tt:IRLamp|On – Request to turn ON an IR illuminator attached to the unit. tt:IRLamp|Off – Request to turn OFF an IR illuminator attached to the unit. tt:IRLamp|Auto – Request to configure an IR illuminator attached to the unit so that it automatically turns ON and OFF. A device that indicates auxiliary service capability shall support this command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SendAuxiliaryCommandRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SendAuxiliaryCommand", + "schema": { + "name": "SendAuxiliaryCommand", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AuxiliaryCommand", + "type": "{http://www.onvif.org/ver10/schema}AuxiliaryData", + "type_name": "AuxiliaryData", + "definition": { + "kind": "simpleType", + "name": "AuxiliaryData", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "128" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SendAuxiliaryCommandResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SendAuxiliaryCommandResponse", + "schema": { + "name": "SendAuxiliaryCommandResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AuxiliaryCommandResponse", + "type": "{http://www.onvif.org/ver10/schema}AuxiliaryData", + "type_name": "AuxiliaryData", + "definition": { + "kind": "simpleType", + "name": "AuxiliaryData", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "128" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetDot11Capabilities", + "port_type": "Device", + "description": "This operation returns the IEEE802.11 capabilities. The device shall support this operation.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDot11CapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDot11Capabilities", + "schema": { + "name": "GetDot11Capabilities", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDot11CapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDot11CapabilitiesResponse", + "schema": { + "name": "GetDot11CapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/schema}Dot11Capabilities", + "type_name": "Dot11Capabilities", + "definition": { + "kind": "complexType", + "name": "Dot11Capabilities", + "fields": [ + { + "name": "TKIP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ScanAvailableNetworks", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MultipleConfiguration", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AdHocStationMode", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "WEP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetDot11Status", + "port_type": "Device", + "description": "This operation returns the status of a wireless network interface. The device shall support this command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDot11StatusRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDot11Status", + "schema": { + "name": "GetDot11Status", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "InterfaceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDot11StatusResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDot11StatusResponse", + "schema": { + "name": "GetDot11StatusResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Status", + "type": "{http://www.onvif.org/ver10/schema}Dot11Status", + "type_name": "Dot11Status", + "definition": { + "kind": "complexType", + "name": "Dot11Status", + "fields": [ + { + "name": "SSID", + "type": "{http://www.onvif.org/ver10/schema}Dot11SSIDType", + "type_name": "Dot11SSIDType", + "definition": { + "kind": "simpleType", + "name": "Dot11SSIDType", + "base": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "minLength": "1", + "maxLength": "32" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "BSSID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "PairCipher", + "type": "{http://www.onvif.org/ver10/schema}Dot11Cipher", + "type_name": "Dot11Cipher", + "definition": { + "kind": "simpleType", + "name": "Dot11Cipher", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "CCMP" + }, + { + "value": "TKIP" + }, + { + "value": "Any" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "GroupCipher", + "type": "{http://www.onvif.org/ver10/schema}Dot11Cipher", + "type_name": "Dot11Cipher", + "definition": { + "kind": "simpleType", + "name": "Dot11Cipher", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "CCMP" + }, + { + "value": "TKIP" + }, + { + "value": "Any" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SignalStrength", + "type": "{http://www.onvif.org/ver10/schema}Dot11SignalStrength", + "type_name": "Dot11SignalStrength", + "definition": { + "kind": "simpleType", + "name": "Dot11SignalStrength", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "None" + }, + { + "value": "Very Bad" + }, + { + "value": "Bad" + }, + { + "value": "Good" + }, + { + "value": "Very Good" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ActiveConfigAlias", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "ScanAvailableDot11Networks", + "port_type": "Device", + "description": "This operation returns a lists of the wireless networks in range of the device. A device should support this operation.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}ScanAvailableDot11NetworksRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}ScanAvailableDot11Networks", + "schema": { + "name": "ScanAvailableDot11Networks", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "InterfaceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}ScanAvailableDot11NetworksResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}ScanAvailableDot11NetworksResponse", + "schema": { + "name": "ScanAvailableDot11NetworksResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Networks", + "type": "{http://www.onvif.org/ver10/schema}Dot11AvailableNetworks", + "type_name": "Dot11AvailableNetworks", + "definition": { + "kind": "complexType", + "name": "Dot11AvailableNetworks", + "fields": [ + { + "name": "SSID", + "type": "{http://www.onvif.org/ver10/schema}Dot11SSIDType", + "type_name": "Dot11SSIDType", + "definition": { + "kind": "simpleType", + "name": "Dot11SSIDType", + "base": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "minLength": "1", + "maxLength": "32" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "BSSID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AuthAndMangementSuite", + "type": "{http://www.onvif.org/ver10/schema}Dot11AuthAndMangementSuite", + "type_name": "Dot11AuthAndMangementSuite", + "definition": { + "kind": "simpleType", + "name": "Dot11AuthAndMangementSuite", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "None" + }, + { + "value": "Dot1X" + }, + { + "value": "PSK" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "See IEEE802.11 7.3.2.25.2 for details." + }, + { + "name": "PairCipher", + "type": "{http://www.onvif.org/ver10/schema}Dot11Cipher", + "type_name": "Dot11Cipher", + "definition": { + "kind": "simpleType", + "name": "Dot11Cipher", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "CCMP" + }, + { + "value": "TKIP" + }, + { + "value": "Any" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "GroupCipher", + "type": "{http://www.onvif.org/ver10/schema}Dot11Cipher", + "type_name": "Dot11Cipher", + "definition": { + "kind": "simpleType", + "name": "Dot11Cipher", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "CCMP" + }, + { + "value": "TKIP" + }, + { + "value": "Any" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SignalStrength", + "type": "{http://www.onvif.org/ver10/schema}Dot11SignalStrength", + "type_name": "Dot11SignalStrength", + "definition": { + "kind": "simpleType", + "name": "Dot11SignalStrength", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "None" + }, + { + "value": "Very Bad" + }, + { + "value": "Bad" + }, + { + "value": "Good" + }, + { + "value": "Very Good" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}Dot11AvailableNetworksExtension", + "type_name": "Dot11AvailableNetworksExtension", + "definition": { + "kind": "complexType", + "name": "Dot11AvailableNetworksExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetSystemUris", + "port_type": "Device", + "description": "This operation is used to retrieve URIs from which system information may be downloaded using HTTP. URIs may be returned for the following system information: System Logs. Multiple system logs may be returned, of different types. The exact format of the system logs is outside the scope of this specification. Support Information. This consists of arbitrary device diagnostics information from a device. The exact format of the diagnostic information is outside the scope of this specification. System Backup. The received file is a backup file that can be used to restore the current device configuration at a later date. The exact format of the backup configuration file is outside the scope of this specification. If the device allows retrieval of system logs, support information or system backup data, it should make them available via HTTP GET. If it does, it shall support the GetSystemUris command.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetSystemUrisRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetSystemUris", + "schema": { + "name": "GetSystemUris", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetSystemUrisResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetSystemUrisResponse", + "schema": { + "name": "GetSystemUrisResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SystemLogUris", + "type": "{http://www.onvif.org/ver10/schema}SystemLogUriList", + "type_name": "SystemLogUriList", + "definition": { + "kind": "complexType", + "name": "SystemLogUriList", + "fields": [ + { + "name": "SystemLog", + "type": "{http://www.onvif.org/ver10/schema}SystemLogUri", + "type_name": "SystemLogUri", + "definition": { + "kind": "complexType", + "name": "SystemLogUri", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}SystemLogType", + "type_name": "SystemLogType", + "definition": { + "kind": "simpleType", + "name": "SystemLogType", + "description": "Enumeration describing the available system log modes.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "System", + "description": "Indicates that a system log is requested." + }, + { + "value": "Access", + "description": "Indicates that a access log is requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportInfoUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SystemBackupUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "StartFirmwareUpgrade", + "port_type": "Device", + "description": "This operation initiates a firmware upgrade using the HTTP POST mechanism. The response to the command includes an HTTP URL to which the upgrade file may be uploaded. The actual upgrade takes place as soon as the HTTP POST operation has completed. The device should support firmware upgrade through the StartFirmwareUpgrade command. The exact format of the firmware data is outside the scope of this specification. Firmware upgrade over HTTP may be achieved using the following steps: Client calls StartFirmwareUpgrade. Server responds with upload URI and optional delay value. Client waits for delay duration if specified by server. Client transmits the firmware image to the upload URI using HTTP POST. Server reprograms itself using the uploaded image, then reboots. If the firmware upgrade fails because the upgrade file was invalid, the HTTP POST response shall be \"415 Unsupported Media Type\". If the firmware upgrade fails due to an error at the device, the HTTP POST response shall be \"500 Internal Server Error\". The value of the Content-Type header in the HTTP POST request shall be \"application/octetstream\".", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}StartFirmwareUpgradeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}StartFirmwareUpgrade", + "schema": { + "name": "StartFirmwareUpgrade", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}StartFirmwareUpgradeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}StartFirmwareUpgradeResponse", + "schema": { + "name": "StartFirmwareUpgradeResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "UploadUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "UploadDelay", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ExpectedDownTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "UpgradeFirmware", + "port_type": "Device", + "description": "This operation initiates a firmware upgrade using between the device and the MCS, without further actions from the client. Cloud firmware upgrade may be achieved using the following steps: Client retrieves the list of available firmware versions from the MCS. Client calls UpgradeFirmware, selecting the desired FW version. Device service responds with a downtime value. Device and MCS perform the firmware upgrade procedure without further interaction from the Client Device notifies the Client of the result by emitting the appropriate CloudFirmwareUpgrade event After applying a firmware upgrade the device shall keep the basic network configuration like IP address, subnet mask and gateway or DHCP settings, as well as all the parameters of the Uplink and Security service unchanged, so that it can connect to the cloud. Additionally a firmware upgrade shall not change user credentials.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}UpgradeFirmwareRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}UpgradeFirmware", + "schema": { + "name": "UpgradeFirmware", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Version", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}UpgradeFirmwareResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}UpgradeFirmwareResponse", + "schema": { + "name": "UpgradeFirmwareResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ExpectedDownTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "StartSystemRestore", + "port_type": "Device", + "description": "This operation initiates a system restore from backed up configuration data using the HTTP POST mechanism. The response to the command includes an HTTP URL to which the backup file may be uploaded. The actual restore takes place as soon as the HTTP POST operation has completed. Devices should support system restore through the StartSystemRestore command. The exact format of the backup configuration data is outside the scope of this specification. System restore over HTTP may be achieved using the following steps: Client calls StartSystemRestore. Server responds with upload URI. Client transmits the configuration data to the upload URI using HTTP POST. Server applies the uploaded configuration, then reboots if necessary. If the system restore fails because the uploaded file was invalid, the HTTP POST response shall be \"415 Unsupported Media Type\". If the system restore fails due to an error at the device, the HTTP POST response shall be \"500 Internal Server Error\". The value of the Content-Type header in the HTTP POST request shall be \"application/octetstream\".", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}StartSystemRestoreRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}StartSystemRestore", + "schema": { + "name": "StartSystemRestore", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}StartSystemRestoreResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}StartSystemRestoreResponse", + "schema": { + "name": "StartSystemRestoreResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "UploadUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ExpectedDownTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetStorageConfigurations", + "port_type": "Device", + "description": "This operation lists all existing storage configurations for the device.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetStorageConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetStorageConfigurations", + "schema": { + "name": "GetStorageConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetStorageConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetStorageConfigurationsResponse", + "schema": { + "name": "GetStorageConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StorageConfigurations", + "type": "{http://www.onvif.org/ver10/device/wsdl}StorageConfiguration", + "type_name": "StorageConfiguration", + "definition": { + "kind": "complexType", + "name": "StorageConfiguration", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Data", + "type": "{http://www.onvif.org/ver10/device/wsdl}StorageConfigurationData", + "type_name": "StorageConfigurationData", + "definition": { + "kind": "complexType", + "name": "StorageConfigurationData", + "fields": [ + { + "name": "LocalPath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Local path" + }, + { + "name": "StorageUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Storage server address" + }, + { + "name": "User", + "type": "{http://www.onvif.org/ver10/device/wsdl}UserCredential", + "type_name": "UserCredential", + "definition": { + "kind": "complexType", + "name": "UserCredential", + "fields": [ + { + "name": "UserName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User name" + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "optional password, device shall not return the credentials (password) in the reply." + }, + { + "name": "Extension", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Token", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "optional access token, device shall not return the credentials (token) in the reply." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User credential for the storage server" + }, + { + "name": "Extension", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the certification path validation policy to be used for validating the server certificate as declared in the security service." + }, + { + "name": "ConfigurationRenewal", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RenewalEndpoint", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Remote URL to be queried by the device to renew the storage configuration." + }, + { + "name": "AuthorizationServer", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "AuthorizationServer token referring to the server that provides access tokens to authorize with the the renewal endpoint." + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "CertPathValidationPolicyID used to validate the renewal endpoint server certificate.\n\t\t\t\t\t\t\t\t\t\t\tIf not configured, server certificate validation behavior is undefined and the device may either apply\n\t\t\t\t\t\t\t\t\t\t\ta vendor specific default validation policy or skip validation at all." + }, + { + "name": "Error", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable error information (readonly)." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "tds:StorageType lists the acceptable values for type attribute" + }, + { + "use": "optional", + "name": "Region", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional region of the storage server" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "CreateStorageConfiguration", + "port_type": "Device", + "description": "This operation creates a new storage configuration. The configuration data shall be created in the device and shall be persistent (remain after reboot).", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}CreateStorageConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}CreateStorageConfiguration", + "schema": { + "name": "CreateStorageConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StorageConfiguration", + "type": "{http://www.onvif.org/ver10/device/wsdl}StorageConfigurationData", + "type_name": "StorageConfigurationData", + "definition": { + "kind": "complexType", + "name": "StorageConfigurationData", + "fields": [ + { + "name": "LocalPath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Local path" + }, + { + "name": "StorageUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Storage server address" + }, + { + "name": "User", + "type": "{http://www.onvif.org/ver10/device/wsdl}UserCredential", + "type_name": "UserCredential", + "definition": { + "kind": "complexType", + "name": "UserCredential", + "fields": [ + { + "name": "UserName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User name" + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "optional password, device shall not return the credentials (password) in the reply." + }, + { + "name": "Extension", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Token", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "optional access token, device shall not return the credentials (token) in the reply." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User credential for the storage server" + }, + { + "name": "Extension", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the certification path validation policy to be used for validating the server certificate as declared in the security service." + }, + { + "name": "ConfigurationRenewal", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RenewalEndpoint", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Remote URL to be queried by the device to renew the storage configuration." + }, + { + "name": "AuthorizationServer", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "AuthorizationServer token referring to the server that provides access tokens to authorize with the the renewal endpoint." + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "CertPathValidationPolicyID used to validate the renewal endpoint server certificate.\n\t\t\t\t\t\t\t\t\t\t\tIf not configured, server certificate validation behavior is undefined and the device may either apply\n\t\t\t\t\t\t\t\t\t\t\ta vendor specific default validation policy or skip validation at all." + }, + { + "name": "Error", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable error information (readonly)." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "tds:StorageType lists the acceptable values for type attribute" + }, + { + "use": "optional", + "name": "Region", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional region of the storage server" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}CreateStorageConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}CreateStorageConfigurationResponse", + "schema": { + "name": "CreateStorageConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetStorageConfiguration", + "port_type": "Device", + "description": "This operation retrieves the Storage configuration associated with the given storage configuration token.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetStorageConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetStorageConfiguration", + "schema": { + "name": "GetStorageConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetStorageConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetStorageConfigurationResponse", + "schema": { + "name": "GetStorageConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StorageConfiguration", + "type": "{http://www.onvif.org/ver10/device/wsdl}StorageConfiguration", + "type_name": "StorageConfiguration", + "definition": { + "kind": "complexType", + "name": "StorageConfiguration", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Data", + "type": "{http://www.onvif.org/ver10/device/wsdl}StorageConfigurationData", + "type_name": "StorageConfigurationData", + "definition": { + "kind": "complexType", + "name": "StorageConfigurationData", + "fields": [ + { + "name": "LocalPath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Local path" + }, + { + "name": "StorageUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Storage server address" + }, + { + "name": "User", + "type": "{http://www.onvif.org/ver10/device/wsdl}UserCredential", + "type_name": "UserCredential", + "definition": { + "kind": "complexType", + "name": "UserCredential", + "fields": [ + { + "name": "UserName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User name" + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "optional password, device shall not return the credentials (password) in the reply." + }, + { + "name": "Extension", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Token", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "optional access token, device shall not return the credentials (token) in the reply." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User credential for the storage server" + }, + { + "name": "Extension", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the certification path validation policy to be used for validating the server certificate as declared in the security service." + }, + { + "name": "ConfigurationRenewal", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RenewalEndpoint", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Remote URL to be queried by the device to renew the storage configuration." + }, + { + "name": "AuthorizationServer", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "AuthorizationServer token referring to the server that provides access tokens to authorize with the the renewal endpoint." + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "CertPathValidationPolicyID used to validate the renewal endpoint server certificate.\n\t\t\t\t\t\t\t\t\t\t\tIf not configured, server certificate validation behavior is undefined and the device may either apply\n\t\t\t\t\t\t\t\t\t\t\ta vendor specific default validation policy or skip validation at all." + }, + { + "name": "Error", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable error information (readonly)." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "tds:StorageType lists the acceptable values for type attribute" + }, + { + "use": "optional", + "name": "Region", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional region of the storage server" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetStorageConfiguration", + "port_type": "Device", + "description": "This operation modifies an existing Storage configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetStorageConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetStorageConfiguration", + "schema": { + "name": "SetStorageConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StorageConfiguration", + "type": "{http://www.onvif.org/ver10/device/wsdl}StorageConfiguration", + "type_name": "StorageConfiguration", + "definition": { + "kind": "complexType", + "name": "StorageConfiguration", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Data", + "type": "{http://www.onvif.org/ver10/device/wsdl}StorageConfigurationData", + "type_name": "StorageConfigurationData", + "definition": { + "kind": "complexType", + "name": "StorageConfigurationData", + "fields": [ + { + "name": "LocalPath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Local path" + }, + { + "name": "StorageUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Storage server address" + }, + { + "name": "User", + "type": "{http://www.onvif.org/ver10/device/wsdl}UserCredential", + "type_name": "UserCredential", + "definition": { + "kind": "complexType", + "name": "UserCredential", + "fields": [ + { + "name": "UserName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User name" + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "optional password, device shall not return the credentials (password) in the reply." + }, + { + "name": "Extension", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Token", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "optional access token, device shall not return the credentials (token) in the reply." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User credential for the storage server" + }, + { + "name": "Extension", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The unique identifier of the certification path validation policy to be used for validating the server certificate as declared in the security service." + }, + { + "name": "ConfigurationRenewal", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RenewalEndpoint", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Remote URL to be queried by the device to renew the storage configuration." + }, + { + "name": "AuthorizationServer", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "AuthorizationServer token referring to the server that provides access tokens to authorize with the the renewal endpoint." + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "CertPathValidationPolicyID used to validate the renewal endpoint server certificate.\n\t\t\t\t\t\t\t\t\t\t\tIf not configured, server certificate validation behavior is undefined and the device may either apply\n\t\t\t\t\t\t\t\t\t\t\ta vendor specific default validation policy or skip validation at all." + }, + { + "name": "Error", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable error information (readonly)." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "tds:StorageType lists the acceptable values for type attribute" + }, + { + "use": "optional", + "name": "Region", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional region of the storage server" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetStorageConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetStorageConfigurationResponse", + "schema": { + "name": "SetStorageConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "DeleteStorageConfiguration", + "port_type": "Device", + "description": "This operation deletes the given storage configuration and configuration change shall always be persistent.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}DeleteStorageConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}DeleteStorageConfiguration", + "schema": { + "name": "DeleteStorageConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}DeleteStorageConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}DeleteStorageConfigurationResponse", + "schema": { + "name": "DeleteStorageConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetGeoLocation", + "port_type": "Device", + "description": "This operation lists all existing geo location configurations for the device.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetGeoLocationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetGeoLocation", + "schema": { + "name": "GetGeoLocation", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetGeoLocationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetGeoLocationResponse", + "schema": { + "name": "GetGeoLocationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Location", + "type": "{http://www.onvif.org/ver10/schema}LocationEntity", + "type_name": "LocationEntity", + "definition": { + "kind": "complexType", + "name": "LocationEntity", + "fields": [ + { + "name": "GeoLocation", + "type": "{http://www.onvif.org/ver10/schema}GeoLocation", + "type_name": "GeoLocation", + "definition": { + "kind": "complexType", + "name": "GeoLocation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "lon", + "type": "{http://www.w3.org/2001/XMLSchema}double", + "description": "East west location as angle." + }, + { + "use": "optional", + "name": "lat", + "type": "{http://www.w3.org/2001/XMLSchema}double", + "description": "North south location as angle." + }, + { + "use": "optional", + "name": "elevation", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Height in meters above sea level." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Location on earth." + }, + { + "name": "GeoOrientation", + "type": "{http://www.onvif.org/ver10/schema}GeoOrientation", + "type_name": "GeoOrientation", + "definition": { + "kind": "complexType", + "name": "GeoOrientation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "roll", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the x axis." + }, + { + "use": "optional", + "name": "pitch", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the y axis." + }, + { + "use": "optional", + "name": "yaw", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the z axis." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Orientation relative to earth." + }, + { + "name": "LocalLocation", + "type": "{http://www.onvif.org/ver10/schema}LocalLocation", + "type_name": "LocalLocation", + "definition": { + "kind": "complexType", + "name": "LocalLocation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "East west location as angle." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "North south location as angle." + }, + { + "use": "optional", + "name": "z", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Offset in meters from the sea level." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indoor location offset." + }, + { + "name": "LocalOrientation", + "type": "{http://www.onvif.org/ver10/schema}LocalOrientation", + "type_name": "LocalOrientation", + "definition": { + "kind": "complexType", + "name": "LocalOrientation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "pan", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the y axis." + }, + { + "use": "optional", + "name": "tilt", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the z axis." + }, + { + "use": "optional", + "name": "roll", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the x axis." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indoor orientation offset." + } + ], + "attributes": [ + { + "use": "optional", + "name": "Entity", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Entity type the entry refers to, use a value from the tt:Entity enumeration." + }, + { + "use": "optional", + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Optional entity token." + }, + { + "use": "optional", + "name": "Fixed", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "If this value is true the entity cannot be deleted." + }, + { + "use": "optional", + "name": "GeoSource", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Optional reference to the XAddr of another devices DeviceManagement service." + }, + { + "use": "optional", + "name": "AutoGeo", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "If set the geo location is obtained internally." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetGeoLocation", + "port_type": "Device", + "description": "This operation allows to modify one or more geo configuration entries.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetGeoLocationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetGeoLocation", + "schema": { + "name": "SetGeoLocation", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Location", + "type": "{http://www.onvif.org/ver10/schema}LocationEntity", + "type_name": "LocationEntity", + "definition": { + "kind": "complexType", + "name": "LocationEntity", + "fields": [ + { + "name": "GeoLocation", + "type": "{http://www.onvif.org/ver10/schema}GeoLocation", + "type_name": "GeoLocation", + "definition": { + "kind": "complexType", + "name": "GeoLocation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "lon", + "type": "{http://www.w3.org/2001/XMLSchema}double", + "description": "East west location as angle." + }, + { + "use": "optional", + "name": "lat", + "type": "{http://www.w3.org/2001/XMLSchema}double", + "description": "North south location as angle." + }, + { + "use": "optional", + "name": "elevation", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Height in meters above sea level." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Location on earth." + }, + { + "name": "GeoOrientation", + "type": "{http://www.onvif.org/ver10/schema}GeoOrientation", + "type_name": "GeoOrientation", + "definition": { + "kind": "complexType", + "name": "GeoOrientation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "roll", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the x axis." + }, + { + "use": "optional", + "name": "pitch", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the y axis." + }, + { + "use": "optional", + "name": "yaw", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the z axis." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Orientation relative to earth." + }, + { + "name": "LocalLocation", + "type": "{http://www.onvif.org/ver10/schema}LocalLocation", + "type_name": "LocalLocation", + "definition": { + "kind": "complexType", + "name": "LocalLocation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "East west location as angle." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "North south location as angle." + }, + { + "use": "optional", + "name": "z", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Offset in meters from the sea level." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indoor location offset." + }, + { + "name": "LocalOrientation", + "type": "{http://www.onvif.org/ver10/schema}LocalOrientation", + "type_name": "LocalOrientation", + "definition": { + "kind": "complexType", + "name": "LocalOrientation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "pan", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the y axis." + }, + { + "use": "optional", + "name": "tilt", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the z axis." + }, + { + "use": "optional", + "name": "roll", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the x axis." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indoor orientation offset." + } + ], + "attributes": [ + { + "use": "optional", + "name": "Entity", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Entity type the entry refers to, use a value from the tt:Entity enumeration." + }, + { + "use": "optional", + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Optional entity token." + }, + { + "use": "optional", + "name": "Fixed", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "If this value is true the entity cannot be deleted." + }, + { + "use": "optional", + "name": "GeoSource", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Optional reference to the XAddr of another devices DeviceManagement service." + }, + { + "use": "optional", + "name": "AutoGeo", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "If set the geo location is obtained internally." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetGeoLocationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetGeoLocationResponse", + "schema": { + "name": "SetGeoLocationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "DeleteGeoLocation", + "port_type": "Device", + "description": "This operation deletes the given geo location entries.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}DeleteGeoLocationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}DeleteGeoLocation", + "schema": { + "name": "DeleteGeoLocation", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Location", + "type": "{http://www.onvif.org/ver10/schema}LocationEntity", + "type_name": "LocationEntity", + "definition": { + "kind": "complexType", + "name": "LocationEntity", + "fields": [ + { + "name": "GeoLocation", + "type": "{http://www.onvif.org/ver10/schema}GeoLocation", + "type_name": "GeoLocation", + "definition": { + "kind": "complexType", + "name": "GeoLocation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "lon", + "type": "{http://www.w3.org/2001/XMLSchema}double", + "description": "East west location as angle." + }, + { + "use": "optional", + "name": "lat", + "type": "{http://www.w3.org/2001/XMLSchema}double", + "description": "North south location as angle." + }, + { + "use": "optional", + "name": "elevation", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Height in meters above sea level." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Location on earth." + }, + { + "name": "GeoOrientation", + "type": "{http://www.onvif.org/ver10/schema}GeoOrientation", + "type_name": "GeoOrientation", + "definition": { + "kind": "complexType", + "name": "GeoOrientation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "roll", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the x axis." + }, + { + "use": "optional", + "name": "pitch", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the y axis." + }, + { + "use": "optional", + "name": "yaw", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the z axis." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Orientation relative to earth." + }, + { + "name": "LocalLocation", + "type": "{http://www.onvif.org/ver10/schema}LocalLocation", + "type_name": "LocalLocation", + "definition": { + "kind": "complexType", + "name": "LocalLocation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "East west location as angle." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "North south location as angle." + }, + { + "use": "optional", + "name": "z", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Offset in meters from the sea level." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indoor location offset." + }, + { + "name": "LocalOrientation", + "type": "{http://www.onvif.org/ver10/schema}LocalOrientation", + "type_name": "LocalOrientation", + "definition": { + "kind": "complexType", + "name": "LocalOrientation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "pan", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the y axis." + }, + { + "use": "optional", + "name": "tilt", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the z axis." + }, + { + "use": "optional", + "name": "roll", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the x axis." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indoor orientation offset." + } + ], + "attributes": [ + { + "use": "optional", + "name": "Entity", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Entity type the entry refers to, use a value from the tt:Entity enumeration." + }, + { + "use": "optional", + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Optional entity token." + }, + { + "use": "optional", + "name": "Fixed", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "If this value is true the entity cannot be deleted." + }, + { + "use": "optional", + "name": "GeoSource", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Optional reference to the XAddr of another devices DeviceManagement service." + }, + { + "use": "optional", + "name": "AutoGeo", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "If set the geo location is obtained internally." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}DeleteGeoLocationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}DeleteGeoLocationResponse", + "schema": { + "name": "DeleteGeoLocationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetHashingAlgorithm", + "port_type": "Device", + "description": "This operation sets the hashing algorithm(s) used in HTTP and RTSP Digest Authentication.", + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetHashingAlgorithmRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetHashingAlgorithm", + "schema": { + "name": "SetHashingAlgorithm", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Algorithm", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Hashing algorithm(s) used in HTTP and RTSP Digest Authentication." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetHashingAlgorithmResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetHashingAlgorithmResponse", + "schema": { + "name": "SetHashingAlgorithmResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "CreateCertificate", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}CreateCertificateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}CreateCertificate", + "schema": { + "name": "CreateCertificate", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Certificate id." + }, + { + "name": "Subject", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Identification of the entity associated with the public-key." + }, + { + "name": "ValidNotBefore", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Certificate validity start date." + }, + { + "name": "ValidNotAfter", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Certificate expiry start date." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}CreateCertificateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}CreateCertificateResponse", + "schema": { + "name": "CreateCertificateResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NvtCertificate", + "type": "{http://www.onvif.org/ver10/schema}Certificate", + "type_name": "Certificate", + "definition": { + "kind": "complexType", + "name": "Certificate", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Certificate id." + }, + { + "name": "Certificate", + "type": "{http://www.onvif.org/ver10/schema}BinaryData", + "type_name": "BinaryData", + "definition": { + "kind": "complexType", + "name": "BinaryData", + "fields": [ + { + "name": "Data", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded binary data." + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded DER representation of certificate." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded DER representation of certificate." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetCertificates", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetCertificatesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetCertificates", + "schema": { + "name": "GetCertificates", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetCertificatesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetCertificatesResponse", + "schema": { + "name": "GetCertificatesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NvtCertificate", + "type": "{http://www.onvif.org/ver10/schema}Certificate", + "type_name": "Certificate", + "definition": { + "kind": "complexType", + "name": "Certificate", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Certificate id." + }, + { + "name": "Certificate", + "type": "{http://www.onvif.org/ver10/schema}BinaryData", + "type_name": "BinaryData", + "definition": { + "kind": "complexType", + "name": "BinaryData", + "fields": [ + { + "name": "Data", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded binary data." + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded DER representation of certificate." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Id and base64 encoded DER representation of all available certificates." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetCertificatesStatus", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetCertificatesStatusRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetCertificatesStatus", + "schema": { + "name": "GetCertificatesStatus", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetCertificatesStatusResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetCertificatesStatusResponse", + "schema": { + "name": "GetCertificatesStatusResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificateStatus", + "type": "{http://www.onvif.org/ver10/schema}CertificateStatus", + "type_name": "CertificateStatus", + "definition": { + "kind": "complexType", + "name": "CertificateStatus", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Certificate id." + }, + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not a certificate is used in an HTTPS configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Indicates if a certificate is used in an optional HTTPS configuration of the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetCertificatesStatus", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetCertificatesStatusRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetCertificatesStatus", + "schema": { + "name": "SetCertificatesStatus", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificateStatus", + "type": "{http://www.onvif.org/ver10/schema}CertificateStatus", + "type_name": "CertificateStatus", + "definition": { + "kind": "complexType", + "name": "CertificateStatus", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Certificate id." + }, + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not a certificate is used in an HTTPS configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Indicates if a certificate is to be used in an optional HTTPS configuration of the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetCertificatesStatusResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetCertificatesStatusResponse", + "schema": { + "name": "SetCertificatesStatusResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "DeleteCertificates", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}DeleteCertificatesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}DeleteCertificates", + "schema": { + "name": "DeleteCertificates", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of ids of certificates to delete." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}DeleteCertificatesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}DeleteCertificatesResponse", + "schema": { + "name": "DeleteCertificatesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetPkcs10Request", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetPkcs10RequestRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetPkcs10Request", + "schema": { + "name": "GetPkcs10Request", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of ids of certificates to delete." + }, + { + "name": "Subject", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Relative Dinstinguished Name(RDN) CommonName(CN)." + }, + { + "name": "Attributes", + "type": "{http://www.onvif.org/ver10/schema}BinaryData", + "type_name": "BinaryData", + "definition": { + "kind": "complexType", + "name": "BinaryData", + "fields": [ + { + "name": "Data", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded binary data." + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional base64 encoded DER attributes." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetPkcs10RequestResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetPkcs10RequestResponse", + "schema": { + "name": "GetPkcs10RequestResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Pkcs10Request", + "type": "{http://www.onvif.org/ver10/schema}BinaryData", + "type_name": "BinaryData", + "definition": { + "kind": "complexType", + "name": "BinaryData", + "fields": [ + { + "name": "Data", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded binary data." + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded DER representation of certificate." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "LoadCertificates", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}LoadCertificatesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}LoadCertificates", + "schema": { + "name": "LoadCertificates", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NVTCertificate", + "type": "{http://www.onvif.org/ver10/schema}Certificate", + "type_name": "Certificate", + "definition": { + "kind": "complexType", + "name": "Certificate", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Certificate id." + }, + { + "name": "Certificate", + "type": "{http://www.onvif.org/ver10/schema}BinaryData", + "type_name": "BinaryData", + "definition": { + "kind": "complexType", + "name": "BinaryData", + "fields": [ + { + "name": "Data", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded binary data." + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded DER representation of certificate." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional id and base64 encoded DER representation of certificate." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}LoadCertificatesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}LoadCertificatesResponse", + "schema": { + "name": "LoadCertificatesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetClientCertificateMode", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetClientCertificateModeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetClientCertificateMode", + "schema": { + "name": "GetClientCertificateMode", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetClientCertificateModeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetClientCertificateModeResponse", + "schema": { + "name": "GetClientCertificateModeResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not client certificates are required by device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetClientCertificateMode", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetClientCertificateModeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetClientCertificateMode", + "schema": { + "name": "SetClientCertificateMode", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not client certificates are required by device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetClientCertificateModeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetClientCertificateModeResponse", + "schema": { + "name": "SetClientCertificateModeResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetCACertificates", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetCACertificatesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetCACertificates", + "schema": { + "name": "GetCACertificates", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetCACertificatesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetCACertificatesResponse", + "schema": { + "name": "GetCACertificatesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CACertificate", + "type": "{http://www.onvif.org/ver10/schema}Certificate", + "type_name": "Certificate", + "definition": { + "kind": "complexType", + "name": "Certificate", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Certificate id." + }, + { + "name": "Certificate", + "type": "{http://www.onvif.org/ver10/schema}BinaryData", + "type_name": "BinaryData", + "definition": { + "kind": "complexType", + "name": "BinaryData", + "fields": [ + { + "name": "Data", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded binary data." + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded DER representation of certificate." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "LoadCertificateWithPrivateKey", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}LoadCertificateWithPrivateKeyRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}LoadCertificateWithPrivateKey", + "schema": { + "name": "LoadCertificateWithPrivateKey", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificateWithPrivateKey", + "type": "{http://www.onvif.org/ver10/schema}CertificateWithPrivateKey", + "type_name": "CertificateWithPrivateKey", + "definition": { + "kind": "complexType", + "name": "CertificateWithPrivateKey", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Certificate", + "type": "{http://www.onvif.org/ver10/schema}BinaryData", + "type_name": "BinaryData", + "definition": { + "kind": "complexType", + "name": "BinaryData", + "fields": [ + { + "name": "Data", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded binary data." + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "PrivateKey", + "type": "{http://www.onvif.org/ver10/schema}BinaryData", + "type_name": "BinaryData", + "definition": { + "kind": "complexType", + "name": "BinaryData", + "fields": [ + { + "name": "Data", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded binary data." + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}LoadCertificateWithPrivateKeyResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}LoadCertificateWithPrivateKeyResponse", + "schema": { + "name": "LoadCertificateWithPrivateKeyResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetCertificateInformation", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetCertificateInformationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetCertificateInformation", + "schema": { + "name": "GetCertificateInformation", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetCertificateInformationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetCertificateInformationResponse", + "schema": { + "name": "GetCertificateInformationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CertificateInformation", + "type": "{http://www.onvif.org/ver10/schema}CertificateInformation", + "type_name": "CertificateInformation", + "definition": { + "kind": "complexType", + "name": "CertificateInformation", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "IssuerDN", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SubjectDN", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "KeyUsage", + "type": "{http://www.onvif.org/ver10/schema}CertificateUsage", + "type_name": "CertificateUsage", + "definition": { + "kind": "complexType", + "name": "CertificateUsage", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Critical", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ExtendedKeyUsage", + "type": "{http://www.onvif.org/ver10/schema}CertificateUsage", + "type_name": "CertificateUsage", + "definition": { + "kind": "complexType", + "name": "CertificateUsage", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Critical", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "KeyLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Version", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SerialNum", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SignatureAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Validity Range is from \"NotBefore\" to \"NotAfter\"; the corresponding DateTimeRange is from \"From\" to \"Until\"" + }, + { + "name": "Validity", + "type": "{http://www.onvif.org/ver10/schema}DateTimeRange", + "type_name": "DateTimeRange", + "definition": { + "kind": "complexType", + "name": "DateTimeRange", + "fields": [ + { + "name": "From", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Until", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}CertificateInformationExtension", + "type_name": "CertificateInformationExtension", + "definition": { + "kind": "complexType", + "name": "CertificateInformationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "LoadCACertificates", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}LoadCACertificatesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}LoadCACertificates", + "schema": { + "name": "LoadCACertificates", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CACertificate", + "type": "{http://www.onvif.org/ver10/schema}Certificate", + "type_name": "Certificate", + "definition": { + "kind": "complexType", + "name": "Certificate", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Certificate id." + }, + { + "name": "Certificate", + "type": "{http://www.onvif.org/ver10/schema}BinaryData", + "type_name": "BinaryData", + "definition": { + "kind": "complexType", + "name": "BinaryData", + "fields": [ + { + "name": "Data", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded binary data." + } + ], + "attributes": [ + { + "use": "optional", + "ref": "{http://www.w3.org/2005/05/xmlmime}contentType" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "base64 encoded DER representation of certificate." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}LoadCACertificatesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}LoadCACertificatesResponse", + "schema": { + "name": "LoadCACertificatesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "CreateDot1XConfiguration", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}CreateDot1XConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}CreateDot1XConfiguration", + "schema": { + "name": "CreateDot1XConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Dot1XConfiguration", + "type": "{http://www.onvif.org/ver10/schema}Dot1XConfiguration", + "type_name": "Dot1XConfiguration", + "definition": { + "kind": "complexType", + "name": "Dot1XConfiguration", + "fields": [ + { + "name": "Dot1XConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Identity", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AnonymousID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "EAPMethod", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "EAP Method type as defined in IANA EAP Registry." + }, + { + "name": "CACertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "EAPMethodConfiguration", + "type": "{http://www.onvif.org/ver10/schema}EAPMethodConfiguration", + "type_name": "EAPMethodConfiguration", + "definition": { + "kind": "complexType", + "name": "EAPMethodConfiguration", + "fields": [ + { + "name": "TLSConfiguration", + "type": "{http://www.onvif.org/ver10/schema}TLSConfiguration", + "type_name": "TLSConfiguration", + "definition": { + "kind": "complexType", + "name": "TLSConfiguration", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Configuration information for TLS Method." + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Password for those EAP Methods that require a password. The password shall never be returned on a get method." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}EapMethodExtension", + "type_name": "EapMethodExtension", + "definition": { + "kind": "complexType", + "name": "EapMethodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}Dot1XConfigurationExtension", + "type_name": "Dot1XConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "Dot1XConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}CreateDot1XConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}CreateDot1XConfigurationResponse", + "schema": { + "name": "CreateDot1XConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "SetDot1XConfiguration", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetDot1XConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetDot1XConfiguration", + "schema": { + "name": "SetDot1XConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Dot1XConfiguration", + "type": "{http://www.onvif.org/ver10/schema}Dot1XConfiguration", + "type_name": "Dot1XConfiguration", + "definition": { + "kind": "complexType", + "name": "Dot1XConfiguration", + "fields": [ + { + "name": "Dot1XConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Identity", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AnonymousID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "EAPMethod", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "EAP Method type as defined in IANA EAP Registry." + }, + { + "name": "CACertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "EAPMethodConfiguration", + "type": "{http://www.onvif.org/ver10/schema}EAPMethodConfiguration", + "type_name": "EAPMethodConfiguration", + "definition": { + "kind": "complexType", + "name": "EAPMethodConfiguration", + "fields": [ + { + "name": "TLSConfiguration", + "type": "{http://www.onvif.org/ver10/schema}TLSConfiguration", + "type_name": "TLSConfiguration", + "definition": { + "kind": "complexType", + "name": "TLSConfiguration", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Configuration information for TLS Method." + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Password for those EAP Methods that require a password. The password shall never be returned on a get method." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}EapMethodExtension", + "type_name": "EapMethodExtension", + "definition": { + "kind": "complexType", + "name": "EapMethodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}Dot1XConfigurationExtension", + "type_name": "Dot1XConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "Dot1XConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}SetDot1XConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetDot1XConfigurationResponse", + "schema": { + "name": "SetDot1XConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetDot1XConfiguration", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDot1XConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDot1XConfiguration", + "schema": { + "name": "GetDot1XConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Dot1XConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDot1XConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDot1XConfigurationResponse", + "schema": { + "name": "GetDot1XConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Dot1XConfiguration", + "type": "{http://www.onvif.org/ver10/schema}Dot1XConfiguration", + "type_name": "Dot1XConfiguration", + "definition": { + "kind": "complexType", + "name": "Dot1XConfiguration", + "fields": [ + { + "name": "Dot1XConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Identity", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AnonymousID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "EAPMethod", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "EAP Method type as defined in IANA EAP Registry." + }, + { + "name": "CACertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "EAPMethodConfiguration", + "type": "{http://www.onvif.org/ver10/schema}EAPMethodConfiguration", + "type_name": "EAPMethodConfiguration", + "definition": { + "kind": "complexType", + "name": "EAPMethodConfiguration", + "fields": [ + { + "name": "TLSConfiguration", + "type": "{http://www.onvif.org/ver10/schema}TLSConfiguration", + "type_name": "TLSConfiguration", + "definition": { + "kind": "complexType", + "name": "TLSConfiguration", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Configuration information for TLS Method." + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Password for those EAP Methods that require a password. The password shall never be returned on a get method." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}EapMethodExtension", + "type_name": "EapMethodExtension", + "definition": { + "kind": "complexType", + "name": "EapMethodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}Dot1XConfigurationExtension", + "type_name": "Dot1XConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "Dot1XConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "GetDot1XConfigurations", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDot1XConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDot1XConfigurations", + "schema": { + "name": "GetDot1XConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}GetDot1XConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetDot1XConfigurationsResponse", + "schema": { + "name": "GetDot1XConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Dot1XConfiguration", + "type": "{http://www.onvif.org/ver10/schema}Dot1XConfiguration", + "type_name": "Dot1XConfiguration", + "definition": { + "kind": "complexType", + "name": "Dot1XConfiguration", + "fields": [ + { + "name": "Dot1XConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Identity", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AnonymousID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "EAPMethod", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "EAP Method type as defined in IANA EAP Registry." + }, + { + "name": "CACertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "EAPMethodConfiguration", + "type": "{http://www.onvif.org/ver10/schema}EAPMethodConfiguration", + "type_name": "EAPMethodConfiguration", + "definition": { + "kind": "complexType", + "name": "EAPMethodConfiguration", + "fields": [ + { + "name": "TLSConfiguration", + "type": "{http://www.onvif.org/ver10/schema}TLSConfiguration", + "type_name": "TLSConfiguration", + "definition": { + "kind": "complexType", + "name": "TLSConfiguration", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Configuration information for TLS Method." + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Password for those EAP Methods that require a password. The password shall never be returned on a get method." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}EapMethodExtension", + "type_name": "EapMethodExtension", + "definition": { + "kind": "complexType", + "name": "EapMethodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}Dot1XConfigurationExtension", + "type_name": "Dot1XConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "Dot1XConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + }, + { + "name": "DeleteDot1XConfiguration", + "port_type": "Device", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/device/wsdl}DeleteDot1XConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}DeleteDot1XConfiguration", + "schema": { + "name": "DeleteDot1XConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Dot1XConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/device/wsdl}DeleteDot1XConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}DeleteDot1XConfigurationResponse", + "schema": { + "name": "DeleteDot1XConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/deviceio.json b/docs/generated/wsdl/ver10/deviceio.json new file mode 100644 index 00000000..a78c2b95 --- /dev/null +++ b/docs/generated/wsdl/ver10/deviceio.json @@ -0,0 +1,5283 @@ +{ + "source": "ver10/deviceio.wsdl", + "target_namespace": "http://www.onvif.org/ver10/deviceIO/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "DeviceIOPort", + "description": "Returns the capabilities of the device IO service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "VideoSources", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "default": "0", + "description": "Number of video sources (defaults to none)." + }, + { + "use": "optional", + "name": "VideoOutputs", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "default": "0", + "description": "Number of video outputs (defaults to none)." + }, + { + "use": "optional", + "name": "AudioSources", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "default": "0", + "description": "Number of audio sources (defaults to none)." + }, + { + "use": "optional", + "name": "AudioOutputs", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "default": "0", + "description": "Number of audio outputs (defaults to none)." + }, + { + "use": "optional", + "name": "RelayOutputs", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "default": "0", + "description": "Number of relay outputs (defaults to none)." + }, + { + "use": "optional", + "name": "SerialPorts", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "default": "0", + "description": "Number of serial ports (defaults to none)." + }, + { + "use": "optional", + "name": "DigitalInputs", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "default": "0", + "description": "Number of digital inputs (defaults to none)." + }, + { + "use": "optional", + "name": "DigitalInputOptions", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false", + "description": "Indicates support for DigitalInput configuration of the idle state (defaults to false)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the device IO service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetRelayOutputOptions", + "port_type": "DeviceIOPort", + "description": "Request the available settings and ranges for one or all relay outputs. A device that has one or more RelayOutputs should support this command. Two examples that illustrate usage: 1) Device supports range PT1S to PT120S: Monostable 1 120 2) Device supports values PT0.5S, PT1S, PT2s and PT1M: Monostable 0.5 1 2 60 True ", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetRelayOutputOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetRelayOutputOptions", + "schema": { + "name": "GetRelayOutputOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RelayOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference token to the relay for which the options are requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetRelayOutputOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetRelayOutputOptionsResponse", + "schema": { + "name": "GetRelayOutputOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RelayOutputOptions", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}RelayOutputOptions", + "type_name": "RelayOutputOptions", + "definition": { + "kind": "complexType", + "name": "RelayOutputOptions", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RelayMode", + "type_name": "RelayMode", + "definition": { + "kind": "simpleType", + "name": "RelayMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Monostable" + }, + { + "value": "Bistable" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Supported Modes." + }, + { + "name": "DelayTimes", + "type": "{http://www.onvif.org/ver10/schema}FloatList", + "type_name": "FloatList", + "definition": { + "kind": "simpleType", + "name": "FloatList", + "item_type": "{http://www.w3.org/2001/XMLSchema}float" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Supported delay time range or discrete values in seconds. This element must be present if MonoStable mode is supported." + }, + { + "name": "Discrete", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the relay only supports the exact values for the DelayTimes listed. Default is false." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}RelayOutputOptionsExtension", + "type_name": "RelayOutputOptionsExtension", + "definition": { + "kind": "complexType", + "name": "RelayOutputOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token of the relay output." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Valid values and ranges for the configuration of a relay output." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetAudioSources", + "port_type": "DeviceIOPort", + "description": "List all available audio sources for the device. The device that has one or more audio sources shall support the listing of available audio inputs through the GetAudioSources command.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioSourcesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioSources", + "schema": { + "name": "GetAudioSources", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}Get", + "type_name": "Get", + "definition": { + "kind": "complexType", + "name": "Get", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioSourcesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioSourcesResponse", + "schema": { + "name": "GetAudioSourcesResponse", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetResponse", + "type_name": "GetResponse", + "definition": { + "kind": "complexType", + "name": "GetResponse", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List tokens of a physical IO of a device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetAudioOutputs", + "port_type": "DeviceIOPort", + "description": "List all available audio outputs of a device. A device that has one ore more physical audio outputs shall support listing of available audio outputs through the GetAudioOutputs command.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioOutputsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioOutputs", + "schema": { + "name": "GetAudioOutputs", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}Get", + "type_name": "Get", + "definition": { + "kind": "complexType", + "name": "Get", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioOutputsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioOutputsResponse", + "schema": { + "name": "GetAudioOutputsResponse", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetResponse", + "type_name": "GetResponse", + "definition": { + "kind": "complexType", + "name": "GetResponse", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List tokens of a physical IO of a device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetVideoSources", + "port_type": "DeviceIOPort", + "description": "List all available video sources for the device. The device that has one or more video inputs shall support the listing of available video sources through the GetVideoSources command.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoSourcesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoSources", + "schema": { + "name": "GetVideoSources", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}Get", + "type_name": "Get", + "definition": { + "kind": "complexType", + "name": "Get", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoSourcesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoSourcesResponse", + "schema": { + "name": "GetVideoSourcesResponse", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetResponse", + "type_name": "GetResponse", + "definition": { + "kind": "complexType", + "name": "GetResponse", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List tokens of a physical IO of a device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetVideoOutputs", + "port_type": "DeviceIOPort", + "description": "List all available video outputs of a device. A device that has one or more physical video outputs shall support listing of available video outputs through the GetVideoOutputs command.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoOutputsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoOutputs", + "schema": { + "name": "GetVideoOutputs", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoOutputsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoOutputsResponse", + "schema": { + "name": "GetVideoOutputsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutputs", + "type": "{http://www.onvif.org/ver10/schema}VideoOutput", + "type_name": "VideoOutput", + "definition": { + "kind": "complexType", + "name": "VideoOutput", + "description": "Representation of a physical video outputs.", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Layout", + "type": "{http://www.onvif.org/ver10/schema}Layout", + "type_name": "Layout", + "definition": { + "kind": "complexType", + "name": "Layout", + "description": "A layout describes a set of Video windows that are displayed simultaneously on a display.", + "fields": [ + { + "name": "PaneLayout", + "type": "{http://www.onvif.org/ver10/schema}PaneLayout", + "type_name": "PaneLayout", + "definition": { + "kind": "complexType", + "name": "PaneLayout", + "description": "A pane layout describes one Video window of a display. It links a pane configuration to a region of the screen.", + "fields": [ + { + "name": "Pane", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the configuration of the streaming and coding parameters." + }, + { + "name": "Area", + "type": "{http://www.onvif.org/ver10/schema}Rectangle", + "type_name": "Rectangle", + "definition": { + "kind": "complexType", + "name": "Rectangle", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "bottom", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "top", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "right", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "left", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Describes the location and size of the area on the monitor. The area coordinate values are expressed in normalized units [-1.0, 1.0]." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of panes assembling the display layout." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}LayoutExtension", + "type_name": "LayoutExtension", + "definition": { + "kind": "complexType", + "name": "LayoutExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Resolution of the display in Pixel." + }, + { + "name": "RefreshRate", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Refresh rate of the display in Hertz." + }, + { + "name": "AspectRatio", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Aspect ratio of the display as physical extent of width divided by height." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoOutputExtension", + "type_name": "VideoOutputExtension", + "definition": { + "kind": "complexType", + "name": "VideoOutputExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List containing all physical Video output connections of a device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetVideoSourceConfiguration", + "port_type": "DeviceIOPort", + "description": "Get the video source configurations of a VideoSource. A device with one or more video sources shall support the GetVideoSourceConfigurations command.This method is deprecated.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoSourceConfiguration", + "schema": { + "name": "GetVideoSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested VideoSource." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoSourceConfigurationResponse", + "schema": { + "name": "GetVideoSourceConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceConfiguration", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfiguration", + "type_name": "VideoSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the physical input." + }, + { + "name": "Bounds", + "type": "{http://www.onvif.org/ver10/schema}IntRectangle", + "type_name": "IntRectangle", + "definition": { + "kind": "complexType", + "name": "IntRectangle", + "description": "Rectangle defined by lower left corner position and size. Units are pixel.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "width", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "height", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension", + "type_name": "VideoSourceConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}Rotate", + "type_name": "Rotate", + "definition": { + "kind": "complexType", + "name": "Rotate", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Rotation feature." + }, + { + "name": "Degree", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateExtension", + "type_name": "RotateExtension", + "definition": { + "kind": "complexType", + "name": "RotateExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
\n\t\t\t\twhen Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rotation of captured image.\n\t\t\t\t\t\tWhat resolutions a device supports shall be unaffected by the Rotate parameters.
\n\t\t\t\t\t\tIf a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
\n\t\t\t\t\t\tThe device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition:\n\t\t\t\t\t\tif Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension2", + "type_name": "VideoSourceConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension2", + "fields": [ + { + "name": "LensDescription", + "type": "{http://www.onvif.org/ver10/schema}LensDescription", + "type_name": "LensDescription", + "definition": { + "kind": "complexType", + "name": "LensDescription", + "fields": [ + { + "name": "Offset", + "type": "{http://www.onvif.org/ver10/schema}LensOffset", + "type_name": "LensOffset", + "definition": { + "kind": "complexType", + "name": "LensOffset", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional horizontal offset of the lens center in normalized coordinates." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional vertical offset of the lens center in normalized coordinates." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Offset of the lens center to the imager center in normalized coordinates." + }, + { + "name": "Projection", + "type": "{http://www.onvif.org/ver10/schema}LensProjection", + "type_name": "LensProjection", + "definition": { + "kind": "complexType", + "name": "LensProjection", + "fields": [ + { + "name": "Angle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Angle of incidence." + }, + { + "name": "Radius", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mapping radius as a consequence of the emergent angle." + }, + { + "name": "Transmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ray absorption at the given angle due to vignetting. A value of one means no absorption." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation\n\t\t\t\t\tover the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius.\n\t\t\t\t\tItems outside the last projection Radius shall be assumed to be invisible (black)." + }, + { + "name": "XFactor", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Compensation of the x coordinate needed for the ONVIF normalized coordinate system." + } + ], + "attributes": [ + { + "use": "optional", + "name": "FocalLength", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional focal length of the optical system." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional element describing the geometric lens distortion. Multiple instances for future variable lens support." + }, + { + "name": "SceneOrientation", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientation", + "type_name": "SceneOrientation", + "definition": { + "kind": "complexType", + "name": "SceneOrientation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to assign the way the camera determines the scene orientation." + }, + { + "name": "Orientation", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field\n\t\t\t\t\t\tis optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required\n\t\t\t\t\t\tand the device will return an InvalidArgs fault if missing." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element describing the scene orientation in the camera's field of view." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "ViewMode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current configuration of the Video input." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetVideoOutputConfiguration", + "port_type": "DeviceIOPort", + "description": "Get the configuration of a Video Output. A device that has one or more Video Outputs shall support the retrieval of the VideoOutputConfiguration through this command.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoOutputConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoOutputConfiguration", + "schema": { + "name": "GetVideoOutputConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested VideoOutput." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoOutputConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoOutputConfigurationResponse", + "schema": { + "name": "GetVideoOutputConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutputConfiguration", + "type": "{http://www.onvif.org/ver10/schema}VideoOutputConfiguration", + "type_name": "VideoOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Video Output the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current configuration of the Video output." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetAudioSourceConfiguration", + "port_type": "DeviceIOPort", + "description": "List the configuration of an Audio Input. A device with one or more audio inputs shall support the GetAudioSourceConfiguration command.This method is deprecated.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioSourceConfiguration", + "schema": { + "name": "GetAudioSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AudioSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested AudioSource." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioSourceConfigurationResponse", + "schema": { + "name": "GetAudioSourceConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AudioSourceConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfiguration", + "type_name": "AudioSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Audio Source the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current configuration of the Audio input." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetAudioOutputConfiguration", + "port_type": "DeviceIOPort", + "description": "Request the current configuration of a physical Audio output. A device that has one or more AudioOutputs shall support the retrieval of the AudioOutputConfiguration through this command.This method is deprecated.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioOutputConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioOutputConfiguration", + "schema": { + "name": "GetAudioOutputConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio output." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioOutputConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioOutputConfigurationResponse", + "schema": { + "name": "GetAudioOutputConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AudioOutputConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfiguration", + "type_name": "AudioOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio output." + }, + { + "name": "SendPrimacy", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\t\t\tneeds to be switched.\n\t\t\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current configuration of the Audio output." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "SetVideoSourceConfiguration", + "port_type": "DeviceIOPort", + "description": "Modify a video input configuration. A device that has one or more video sources shall support the setting of the VideoSourceConfiguration through this command.This method is deprecated.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetVideoSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetVideoSourceConfiguration", + "schema": { + "name": "SetVideoSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfiguration", + "type_name": "VideoSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the physical input." + }, + { + "name": "Bounds", + "type": "{http://www.onvif.org/ver10/schema}IntRectangle", + "type_name": "IntRectangle", + "definition": { + "kind": "complexType", + "name": "IntRectangle", + "description": "Rectangle defined by lower left corner position and size. Units are pixel.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "width", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "height", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension", + "type_name": "VideoSourceConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}Rotate", + "type_name": "Rotate", + "definition": { + "kind": "complexType", + "name": "Rotate", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Rotation feature." + }, + { + "name": "Degree", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateExtension", + "type_name": "RotateExtension", + "definition": { + "kind": "complexType", + "name": "RotateExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
\n\t\t\t\twhen Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rotation of captured image.\n\t\t\t\t\t\tWhat resolutions a device supports shall be unaffected by the Rotate parameters.
\n\t\t\t\t\t\tIf a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
\n\t\t\t\t\t\tThe device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition:\n\t\t\t\t\t\tif Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension2", + "type_name": "VideoSourceConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension2", + "fields": [ + { + "name": "LensDescription", + "type": "{http://www.onvif.org/ver10/schema}LensDescription", + "type_name": "LensDescription", + "definition": { + "kind": "complexType", + "name": "LensDescription", + "fields": [ + { + "name": "Offset", + "type": "{http://www.onvif.org/ver10/schema}LensOffset", + "type_name": "LensOffset", + "definition": { + "kind": "complexType", + "name": "LensOffset", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional horizontal offset of the lens center in normalized coordinates." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional vertical offset of the lens center in normalized coordinates." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Offset of the lens center to the imager center in normalized coordinates." + }, + { + "name": "Projection", + "type": "{http://www.onvif.org/ver10/schema}LensProjection", + "type_name": "LensProjection", + "definition": { + "kind": "complexType", + "name": "LensProjection", + "fields": [ + { + "name": "Angle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Angle of incidence." + }, + { + "name": "Radius", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mapping radius as a consequence of the emergent angle." + }, + { + "name": "Transmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ray absorption at the given angle due to vignetting. A value of one means no absorption." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation\n\t\t\t\t\tover the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius.\n\t\t\t\t\tItems outside the last projection Radius shall be assumed to be invisible (black)." + }, + { + "name": "XFactor", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Compensation of the x coordinate needed for the ONVIF normalized coordinate system." + } + ], + "attributes": [ + { + "use": "optional", + "name": "FocalLength", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional focal length of the optical system." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional element describing the geometric lens distortion. Multiple instances for future variable lens support." + }, + { + "name": "SceneOrientation", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientation", + "type_name": "SceneOrientation", + "definition": { + "kind": "complexType", + "name": "SceneOrientation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to assign the way the camera determines the scene orientation." + }, + { + "name": "Orientation", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field\n\t\t\t\t\t\tis optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required\n\t\t\t\t\t\tand the device will return an InvalidArgs fault if missing." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element describing the scene orientation in the camera's field of view." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "ViewMode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ForcePersistence element determines how configuration\n\t\t\t\t\t\t\tchanges shall be stored. If true, changes shall be persistent. If false, changes MAY revert to previous values\n\t\t\t\t\t\t\tafter reboot." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetVideoSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetVideoSourceConfigurationResponse", + "schema": { + "name": "SetVideoSourceConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "SetVideoOutputConfiguration", + "port_type": "DeviceIOPort", + "description": "Modify a video output configuration. A device that has one or more video outputs shall support the setting of its video output configuration through this command.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetVideoOutputConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetVideoOutputConfiguration", + "schema": { + "name": "SetVideoOutputConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}VideoOutputConfiguration", + "type_name": "VideoOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Video Output the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ForcePersistence element determines how configuration\n\t\t\t\t\t\t\tchanges shall be stored. If true, changes shall be persistent. If false, changes MAY revert to previous values\n\t\t\t\t\t\t\tafter reboot." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetVideoOutputConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetVideoOutputConfigurationResponse", + "schema": { + "name": "SetVideoOutputConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "SetAudioSourceConfiguration", + "port_type": "DeviceIOPort", + "description": "Modify an audio source configuration. A device that has a one or more audio sources shall support the setting of the AudioSourceConfiguration through this command.This method is deprecated.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetAudioSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetAudioSourceConfiguration", + "schema": { + "name": "SetAudioSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfiguration", + "type_name": "AudioSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Audio Source the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ForcePersistence element determines how configuration\n\t\t\t\t\t\t\tchanges shall be stored. If true, changes shall be persistent. If false, changes MAY revert to previous values\n\t\t\t\t\t\t\tafter reboot." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetAudioSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetAudioSourceConfigurationResponse", + "schema": { + "name": "SetAudioSourceConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "SetAudioOutputConfiguration", + "port_type": "DeviceIOPort", + "description": "Modify an audio output configuration. A device that has one ore more audio outputs shall support the setting of the AudioOutputConfiguration through this command.This method is deprecated.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetAudioOutputConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetAudioOutputConfiguration", + "schema": { + "name": "SetAudioOutputConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfiguration", + "type_name": "AudioOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio output." + }, + { + "name": "SendPrimacy", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\t\t\tneeds to be switched.\n\t\t\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ForcePersistence element determines how configuration\n\t\t\t\t\t\t\tchanges shall be stored. If true, changes shall be persistent. If false, changes MAY revert to previous values\n\t\t\t\t\t\t\tafter reboot." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetAudioOutputConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetAudioOutputConfigurationResponse", + "schema": { + "name": "SetAudioOutputConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetVideoSourceConfigurationOptions", + "port_type": "DeviceIOPort", + "description": "Request the VideoSourceConfigurationOptions of a VideoSource. A device with one or more video sources shall support this command.This method is deprecated.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoSourceConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoSourceConfigurationOptions", + "schema": { + "name": "GetVideoSourceConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Video input whose options are requested.." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoSourceConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoSourceConfigurationOptionsResponse", + "schema": { + "name": "GetVideoSourceConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceConfigurationOptions", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationOptions", + "type_name": "VideoSourceConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationOptions", + "fields": [ + { + "name": "BoundsRange", + "type": "{http://www.onvif.org/ver10/schema}IntRectangleRange", + "type_name": "IntRectangleRange", + "definition": { + "kind": "complexType", + "name": "IntRectangleRange", + "description": "Range of a rectangle. The rectangle itself is defined by lower left corner position and size. Units are pixel.", + "fields": [ + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of X-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of Y-axis." + }, + { + "name": "WidthRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of width." + }, + { + "name": "HeightRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of height." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported range for the capturing area.\n\t\t\t\t\t\tDevice that does not support cropped streaming shall express BoundsRange option as mentioned below\n\t\t\t\t\t\tBoundsRange->XRange and BoundsRange->YRange with same Min/Max values HeightRange and WidthRange Min/Max values same as VideoSource Height and Width Limits." + }, + { + "name": "VideoSourceTokensAvailable", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of physical inputs." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationOptionsExtension", + "type_name": "VideoSourceConfigurationOptionsExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationOptionsExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}RotateOptions", + "type_name": "RotateOptions", + "definition": { + "kind": "complexType", + "name": "RotateOptions", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Supported options of Rotate mode parameter." + }, + { + "name": "DegreeList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported degree value for rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateOptionsExtension", + "type_name": "RotateOptionsExtension", + "definition": { + "kind": "complexType", + "name": "RotateOptionsExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Reboot", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Signals if a device requires a reboot after changing the rotation or mirror.\n\t\t\t\tIf a device can handle rotation changes or mirror changes without rebooting this value shall be set to false." + }, + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Signals if video source mirroring is supported." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Options of parameters for Rotation feature." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationOptionsExtension2", + "type_name": "VideoSourceConfigurationOptionsExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationOptionsExtension2", + "fields": [ + { + "name": "SceneOrientationMode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Scene orientation modes supported by the device for this configuration." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "MaximumNumberOfProfiles", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of profiles." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetVideoOutputConfigurationOptions", + "port_type": "DeviceIOPort", + "description": "Request the VideoOutputConfigurationOptions of a VideoOutput. A device that has one or more video outputs shall support the retrieval of VideoOutputConfigurationOptions through this command.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoOutputConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoOutputConfigurationOptions", + "schema": { + "name": "GetVideoOutputConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Video Output whose options are requested.." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoOutputConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetVideoOutputConfigurationOptionsResponse", + "schema": { + "name": "GetVideoOutputConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutputConfigurationOptions", + "type": "{http://www.onvif.org/ver10/schema}VideoOutputConfigurationOptions", + "type_name": "VideoOutputConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "VideoOutputConfigurationOptions", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetAudioSourceConfigurationOptions", + "port_type": "DeviceIOPort", + "description": "Request the AudioSourceConfigurationOptions of an AudioSource. A device with one ore more AudioSources shall support this command.This method is deprecated.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioSourceConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioSourceConfigurationOptions", + "schema": { + "name": "GetAudioSourceConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AudioSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio input whose options are requested.." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioSourceConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioSourceConfigurationOptionsResponse", + "schema": { + "name": "GetAudioSourceConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AudioSourceOptions", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfigurationOptions", + "type_name": "AudioSourceConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfigurationOptions", + "fields": [ + { + "name": "InputTokensAvailable", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the audio source the configuration can be used for." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceOptionsExtension", + "type_name": "AudioSourceOptionsExtension", + "definition": { + "kind": "complexType", + "name": "AudioSourceOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Returns the AudioSourceToken available." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetAudioOutputConfigurationOptions", + "port_type": "DeviceIOPort", + "description": "Request the available settings and ranges for a physical Audio output. A device that has one or more AudioOutputs shall support this command.This method is deprecated.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioOutputConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioOutputConfigurationOptions", + "schema": { + "name": "GetAudioOutputConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio Output whose options are requested.." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioOutputConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetAudioOutputConfigurationOptionsResponse", + "schema": { + "name": "GetAudioOutputConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AudioOutputOptions", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfigurationOptions", + "type_name": "AudioOutputConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfigurationOptions", + "fields": [ + { + "name": "OutputTokensAvailable", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the physical Audio outputs (typically one)." + }, + { + "name": "SendPrimacyOptions", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\tneeds to be switched.\n\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t
\n\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevelRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Minimum and maximum level range supported for this Output." + }, + { + "name": "EQPresetScheduleSupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether EQPreset scheduling is supported." + }, + { + "name": "EQPresets", + "type": "{http://www.onvif.org/ver10/schema}EQPreset", + "type_name": "EQPreset", + "definition": { + "kind": "complexType", + "name": "EQPreset", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique identifier for the preset." + }, + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Preset name. (Readonly)" + }, + { + "name": "isDefault", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This indicates whether the EQ preset is designated as the default. When the scheduler is inactive, this preset will be applied. Only one preset can be set as the default among the EQ presets linked to an audio output. If all presets have isDefault set to false, the device may automatically select one preset as the default." + }, + { + "name": "ScheduleToken", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional schedule token (if supported)." + }, + { + "name": "isFrequencyDecibelEditable", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the device allows changing the decibel level for frequencies. (Readonly)" + }, + { + "name": "FrequencyDecibelPair", + "type": "{http://www.onvif.org/ver10/schema}FrequencyDecibelPair", + "type_name": "FrequencyDecibelPair", + "definition": { + "kind": "complexType", + "name": "FrequencyDecibelPair", + "fields": [ + { + "name": "CenterFrequency", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The center frequency of the band in hertz (Readonly). For example, value of 1000 refers to 1kHz and 2000 refers to 2kHz." + }, + { + "name": "Decibel", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Decibel value associated with the center frequency." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of frequency decibel pairs, each defined by a center frequency and its corresponding decibel value." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported EQPresets." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Available settings and ranges for the requested Audio output." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetRelayOutputs", + "port_type": "DeviceIOPort", + "description": "This operation gets a list of all available relay outputs and their settings.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetRelayOutputsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetRelayOutputs", + "schema": { + "name": "GetRelayOutputs", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetRelayOutputsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}GetRelayOutputsResponse", + "schema": { + "name": "GetRelayOutputsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RelayOutputs", + "type": "{http://www.onvif.org/ver10/schema}RelayOutput", + "type_name": "RelayOutput", + "definition": { + "kind": "complexType", + "name": "RelayOutput", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Properties", + "type": "{http://www.onvif.org/ver10/schema}RelayOutputSettings", + "type_name": "RelayOutputSettings", + "definition": { + "kind": "complexType", + "name": "RelayOutputSettings", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RelayMode", + "type_name": "RelayMode", + "definition": { + "kind": "simpleType", + "name": "RelayMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Monostable" + }, + { + "value": "Bistable" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "'Bistable' or 'Monostable'\n\t\t\t\t\t
    \n\t\t\t\t\t\t\t
  • Bistable - After setting the state, the relay remains in this state.
    • \n\t\t\t\t\t\t\t
  • Monostable - After setting the state, the relay returns to its idle state after the specified time.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "DelayTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Time after which the relay returns to its idle state if it is in monostable mode. If the Mode field is set to bistable mode the value of the parameter can be ignored." + }, + { + "name": "IdleState", + "type": "{http://www.onvif.org/ver10/schema}RelayIdleState", + "type_name": "RelayIdleState", + "definition": { + "kind": "simpleType", + "name": "RelayIdleState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "closed" + }, + { + "value": "open" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "'open' or 'closed'\n\t\t\t
    \n\t\t\t\t\t\t\t
  • 'open' means that the relay is open when the relay state is set to 'inactive' through the trigger command and closed when the state is set to 'active' through the same command.
    • \n\t\t\t\t\t\t\t
  • 'closed' means that the relay is closed when the relay state is set to 'inactive' through the trigger command and open when the state is set to 'active' through the same command.
    • \n\t\t\t\t\t\t
" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "SetRelayOutputSettings", + "port_type": "DeviceIOPort", + "description": "This operation sets the settings of a relay output. The relay can work in two relay modes: Bistable – After setting the state, the relay remains in this state. Monostable – After setting the state, the relay returns to its idle state after the specified time. The physical idle state of a relay output can be configured by setting the IdleState to ‘open’ or ‘closed’ (inversion of the relay behaviour). Idle State ‘open’ means that the relay is open when the relay state is set to ‘inactive’ through the trigger command (see Section 8.5.3) and closed when the state is set to ‘active’ through the same command. Idle State ‘closed’ means, that the relay is closed when the relay state is set to ‘inactive’ through the trigger command (see Section 8.5.3) and open when the state is set to ‘active’ through the same command.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetRelayOutputSettingsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetRelayOutputSettings", + "schema": { + "name": "SetRelayOutputSettings", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RelayOutput", + "type": "{http://www.onvif.org/ver10/schema}RelayOutput", + "type_name": "RelayOutput", + "definition": { + "kind": "complexType", + "name": "RelayOutput", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Properties", + "type": "{http://www.onvif.org/ver10/schema}RelayOutputSettings", + "type_name": "RelayOutputSettings", + "definition": { + "kind": "complexType", + "name": "RelayOutputSettings", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RelayMode", + "type_name": "RelayMode", + "definition": { + "kind": "simpleType", + "name": "RelayMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Monostable" + }, + { + "value": "Bistable" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "'Bistable' or 'Monostable'\n\t\t\t\t\t
    \n\t\t\t\t\t\t\t
  • Bistable - After setting the state, the relay remains in this state.
    • \n\t\t\t\t\t\t\t
  • Monostable - After setting the state, the relay returns to its idle state after the specified time.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "DelayTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Time after which the relay returns to its idle state if it is in monostable mode. If the Mode field is set to bistable mode the value of the parameter can be ignored." + }, + { + "name": "IdleState", + "type": "{http://www.onvif.org/ver10/schema}RelayIdleState", + "type_name": "RelayIdleState", + "definition": { + "kind": "simpleType", + "name": "RelayIdleState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "closed" + }, + { + "value": "open" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "'open' or 'closed'\n\t\t\t
    \n\t\t\t\t\t\t\t
  • 'open' means that the relay is open when the relay state is set to 'inactive' through the trigger command and closed when the state is set to 'active' through the same command.
    • \n\t\t\t\t\t\t\t
  • 'closed' means that the relay is closed when the relay state is set to 'inactive' through the trigger command and open when the state is set to 'active' through the same command.
    • \n\t\t\t\t\t\t
" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetRelayOutputSettingsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetRelayOutputSettingsResponse", + "schema": { + "name": "SetRelayOutputSettingsResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "SetRelayOutputState", + "port_type": "DeviceIOPort", + "description": "Modify the relay state.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetRelayOutputStateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetRelayOutputState", + "schema": { + "name": "SetRelayOutputState", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RelayOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "LogicalState", + "type": "{http://www.onvif.org/ver10/schema}RelayLogicalState", + "type_name": "RelayLogicalState", + "definition": { + "kind": "simpleType", + "name": "RelayLogicalState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "active" + }, + { + "value": "inactive" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetRelayOutputStateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/device/wsdl}SetRelayOutputStateResponse", + "schema": { + "name": "SetRelayOutputStateResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetDigitalInputs", + "port_type": "DeviceIOPort", + "description": "This operation gets a list of all available digital inputs.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetDigitalInputsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetDigitalInputs", + "schema": { + "name": "GetDigitalInputs", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Get the available digital inputs of a device." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetDigitalInputsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetDigitalInputsResponse", + "schema": { + "name": "GetDigitalInputsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DigitalInputs", + "type": "{http://www.onvif.org/ver10/schema}DigitalInput", + "type_name": "DigitalInput", + "definition": { + "kind": "complexType", + "name": "DigitalInput", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "IdleState", + "type": "{http://www.onvif.org/ver10/schema}DigitalIdleState", + "definition": { + "kind": "simpleType", + "name": "DigitalIdleState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "closed" + }, + { + "value": "open" + } + ] + }, + "description": "Indicate the Digital IdleState status." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Requested digital inputs." + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetDigitalInputConfigurationOptions", + "port_type": "DeviceIOPort", + "description": "This operation lists what configuration is available for digital inputs.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetDigitalInputConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetDigitalInputConfigurationOptions", + "schema": { + "name": "GetDigitalInputConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetDigitalInputConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetDigitalInputConfigurationOptionsResponse", + "schema": { + "name": "GetDigitalInputConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DigitalInputOptions", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}DigitalInputConfigurationOptions", + "type_name": "DigitalInputConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "DigitalInputConfigurationOptions", + "fields": [ + { + "name": "IdleState", + "type": "{http://www.onvif.org/ver10/schema}DigitalIdleState", + "type_name": "DigitalIdleState", + "definition": { + "kind": "simpleType", + "name": "DigitalIdleState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "closed" + }, + { + "value": "open" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Configuration Options for a digital input." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "SetDigitalInputConfigurations", + "port_type": "DeviceIOPort", + "description": "Modify a digital input configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetDigitalInputConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetDigitalInputConfigurations", + "schema": { + "name": "SetDigitalInputConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DigitalInputs", + "type": "{http://www.onvif.org/ver10/schema}DigitalInput", + "type_name": "DigitalInput", + "definition": { + "kind": "complexType", + "name": "DigitalInput", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "IdleState", + "type": "{http://www.onvif.org/ver10/schema}DigitalIdleState", + "definition": { + "kind": "simpleType", + "name": "DigitalIdleState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "closed" + }, + { + "value": "open" + } + ] + }, + "description": "Indicate the Digital IdleState status." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetDigitalInputConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetDigitalInputConfigurationsResponse", + "schema": { + "name": "SetDigitalInputConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetSerialPorts", + "port_type": "DeviceIOPort", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetSerialPortsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetSerialPorts", + "schema": { + "name": "GetSerialPorts", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The physical serial port on the device that allows serial data to be read and written." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetSerialPortsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetSerialPortsResponse", + "schema": { + "name": "GetSerialPortsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SerialPort", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}SerialPort", + "type_name": "SerialPort", + "definition": { + "kind": "complexType", + "name": "SerialPort", + "description": "Lists all available serial ports of a device", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Requested serial ports." + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetSerialPortConfiguration", + "port_type": "DeviceIOPort", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetSerialPortConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetSerialPortConfiguration", + "schema": { + "name": "GetSerialPortConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SerialPortToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Gets the configuration that relates to serial port configuration." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetSerialPortConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetSerialPortConfigurationResponse", + "schema": { + "name": "GetSerialPortConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SerialPortConfiguration", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}SerialPortConfiguration", + "type_name": "SerialPortConfiguration", + "definition": { + "kind": "complexType", + "name": "SerialPortConfiguration", + "description": "The parameters for configuring the serial port.", + "fields": [ + { + "name": "BaudRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The transfer bitrate." + }, + { + "name": "ParityBit", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}ParityBit", + "type_name": "ParityBit", + "definition": { + "kind": "simpleType", + "name": "ParityBit", + "description": "The parity for the data error detection.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "None" + }, + { + "value": "Even" + }, + { + "value": "Odd" + }, + { + "value": "Mark" + }, + { + "value": "Space" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The parity for the data error detection." + }, + { + "name": "CharacterLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The bit length for each character." + }, + { + "name": "StopBit", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The number of stop bits used to terminate each character." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + { + "use": "required", + "name": "type", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}SerialPortType", + "definition": { + "kind": "simpleType", + "name": "SerialPortType", + "description": "The type of serial port.Generic can be signaled as a vendor specific serial port type.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "RS232" + }, + { + "value": "RS422HalfDuplex" + }, + { + "value": "RS422FullDuplex" + }, + { + "value": "RS485HalfDuplex" + }, + { + "value": "RS485FullDuplex" + }, + { + "value": "Generic" + } + ] + } + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Requested serial port configuration." + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "SetSerialPortConfiguration", + "port_type": "DeviceIOPort", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetSerialPortConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetSerialPortConfiguration", + "schema": { + "name": "SetSerialPortConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SerialPortConfiguration", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}SerialPortConfiguration", + "type_name": "SerialPortConfiguration", + "definition": { + "kind": "complexType", + "name": "SerialPortConfiguration", + "description": "The parameters for configuring the serial port.", + "fields": [ + { + "name": "BaudRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The transfer bitrate." + }, + { + "name": "ParityBit", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}ParityBit", + "type_name": "ParityBit", + "definition": { + "kind": "simpleType", + "name": "ParityBit", + "description": "The parity for the data error detection.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "None" + }, + { + "value": "Even" + }, + { + "value": "Odd" + }, + { + "value": "Mark" + }, + { + "value": "Space" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The parity for the data error detection." + }, + { + "name": "CharacterLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The bit length for each character." + }, + { + "name": "StopBit", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The number of stop bits used to terminate each character." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + { + "use": "required", + "name": "type", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}SerialPortType", + "definition": { + "kind": "simpleType", + "name": "SerialPortType", + "description": "The type of serial port.Generic can be signaled as a vendor specific serial port type.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "RS232" + }, + { + "value": "RS422HalfDuplex" + }, + { + "value": "RS422FullDuplex" + }, + { + "value": "RS485HalfDuplex" + }, + { + "value": "RS485FullDuplex" + }, + { + "value": "Generic" + } + ] + } + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ForcePersistance", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Sets the configuration that relates to serial port configuration." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetSerialPortConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SetSerialPortConfigurationResponse", + "schema": { + "name": "SetSerialPortConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "GetSerialPortConfigurationOptions", + "port_type": "DeviceIOPort", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetSerialPortConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetSerialPortConfigurationOptions", + "schema": { + "name": "GetSerialPortConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SerialPortToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Gets the configuration options that relates to serial port configuration." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetSerialPortConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}GetSerialPortConfigurationOptionsResponse", + "schema": { + "name": "GetSerialPortConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SerialPortOptions", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}SerialPortConfigurationOptions", + "type_name": "SerialPortConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "SerialPortConfigurationOptions", + "description": "The configuration options that relates to serial port.", + "fields": [ + { + "name": "BaudRateList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The list of configurable transfer bitrate." + }, + { + "name": "ParityBitList", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}ParityBitList", + "type_name": "ParityBitList", + "definition": { + "kind": "complexType", + "name": "ParityBitList", + "description": "The list of configurable parity for the data error detection.", + "fields": [ + { + "name": "Items", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}ParityBit", + "type_name": "ParityBit", + "definition": { + "kind": "simpleType", + "name": "ParityBit", + "description": "The parity for the data error detection.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "None" + }, + { + "value": "Even" + }, + { + "value": "Odd" + }, + { + "value": "Mark" + }, + { + "value": "Space" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The list of configurable parity for the data error detection." + }, + { + "name": "CharacterLengthList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The list of configurable bit length for each character." + }, + { + "name": "StopBitList", + "type": "{http://www.onvif.org/ver10/schema}FloatItems", + "type_name": "FloatItems", + "definition": { + "kind": "complexType", + "name": "FloatItems", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The list of configurable number of stop bits used to terminate each character." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Requested serial port configuration options." + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + }, + { + "name": "SendReceiveSerialCommand", + "port_type": "DeviceIOPort", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SendReceiveSerialCommandRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SendReceiveSerialCommand", + "schema": { + "name": "SendReceiveSerialCommand", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The physical serial port reference to be used when this request is invoked." + }, + { + "name": "SerialData", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}SerialData", + "type_name": "SerialData", + "definition": { + "kind": "complexType", + "name": "SerialData", + "description": "The serial port data.", + "fields": [ + { + "name": "Binary", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "String", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The serial port data." + }, + { + "name": "TimeOut", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates that the command should be responded back within the specified period of time." + }, + { + "name": "DataLength", + "type": "{http://www.w3.org/2001/XMLSchema}integer", + "type_name": "integer", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "This element may be put in the case that data length returned from the connected serial device is already determined as some fixed bytes length. It indicates the length of received data which can be regarded as available." + }, + { + "name": "Delimiter", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "This element may be put in the case that the delimiter codes returned from the connected serial device is already known. It indicates the termination data sequence of the responded data. In case the string has more than one character a device shall interpret the whole string as a single delimiter. Furthermore a device shall return the delimiter character(s) to the client." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Transmitting arbitrary data to the connected serial device and then receiving its response data." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/deviceIO/wsdl}SendReceiveSerialCommandResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/deviceIO/wsdl}SendReceiveSerialCommandResponse", + "schema": { + "name": "SendReceiveSerialCommandResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SerialData", + "type": "{http://www.onvif.org/ver10/deviceIO/wsdl}SerialData", + "type_name": "SerialData", + "definition": { + "kind": "complexType", + "name": "SerialData", + "description": "The serial port data.", + "fields": [ + { + "name": "Binary", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "String", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Receiving the response data." + } + } + ] + }, + "faults": [], + "binding": "DeviceIOBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/display.json b/docs/generated/wsdl/ver10/display.json new file mode 100644 index 00000000..5c9775b9 --- /dev/null +++ b/docs/generated/wsdl/ver10/display.json @@ -0,0 +1,3698 @@ +{ + "source": "ver10/display.wsdl", + "target_namespace": "http://www.onvif.org/ver10/display/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "DisplayPort", + "description": "Returns the capabilities of the display service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/display/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "FixedLayout", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication that the SetLayout command supports only predefined layouts." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the display service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "GetLayout", + "port_type": "DisplayPort", + "description": "Return the current layout of a video output. The Layout assigns a pane configuration to a certain area of the display. The layout settings directly affect a specific video output. The layout consists of a list of PaneConfigurations and their associated display areas.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetLayoutRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetLayout", + "schema": { + "name": "GetLayout", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Video Output whose Layout is requested" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetLayoutResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetLayoutResponse", + "schema": { + "name": "GetLayoutResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Layout", + "type": "{http://www.onvif.org/ver10/schema}Layout", + "type_name": "Layout", + "definition": { + "kind": "complexType", + "name": "Layout", + "description": "A layout describes a set of Video windows that are displayed simultaneously on a display.", + "fields": [ + { + "name": "PaneLayout", + "type": "{http://www.onvif.org/ver10/schema}PaneLayout", + "type_name": "PaneLayout", + "definition": { + "kind": "complexType", + "name": "PaneLayout", + "description": "A pane layout describes one Video window of a display. It links a pane configuration to a region of the screen.", + "fields": [ + { + "name": "Pane", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the configuration of the streaming and coding parameters." + }, + { + "name": "Area", + "type": "{http://www.onvif.org/ver10/schema}Rectangle", + "type_name": "Rectangle", + "definition": { + "kind": "complexType", + "name": "Rectangle", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "bottom", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "top", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "right", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "left", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Describes the location and size of the area on the monitor. The area coordinate values are expressed in normalized units [-1.0, 1.0]." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of panes assembling the display layout." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}LayoutExtension", + "type_name": "LayoutExtension", + "definition": { + "kind": "complexType", + "name": "LayoutExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current layout of the video output." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "SetLayout", + "port_type": "DisplayPort", + "description": "Change the layout of a display (e.g. change from single view to split screen view).The Layout assigns a pane configuration to a certain area of the display. The layout settings directly affect a specific video output. The layout consists of a list of PaneConfigurations and their associated display areas. A device implementation shall be tolerant against rounding errors when matching a layout against its fixed set of layouts by accepting differences of at least one percent.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}SetLayoutRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}SetLayout", + "schema": { + "name": "SetLayout", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Video Output whose Layout shall be changed." + }, + { + "name": "Layout", + "type": "{http://www.onvif.org/ver10/schema}Layout", + "type_name": "Layout", + "definition": { + "kind": "complexType", + "name": "Layout", + "description": "A layout describes a set of Video windows that are displayed simultaneously on a display.", + "fields": [ + { + "name": "PaneLayout", + "type": "{http://www.onvif.org/ver10/schema}PaneLayout", + "type_name": "PaneLayout", + "definition": { + "kind": "complexType", + "name": "PaneLayout", + "description": "A pane layout describes one Video window of a display. It links a pane configuration to a region of the screen.", + "fields": [ + { + "name": "Pane", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the configuration of the streaming and coding parameters." + }, + { + "name": "Area", + "type": "{http://www.onvif.org/ver10/schema}Rectangle", + "type_name": "Rectangle", + "definition": { + "kind": "complexType", + "name": "Rectangle", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "bottom", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "top", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "right", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "left", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Describes the location and size of the area on the monitor. The area coordinate values are expressed in normalized units [-1.0, 1.0]." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of panes assembling the display layout." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}LayoutExtension", + "type_name": "LayoutExtension", + "definition": { + "kind": "complexType", + "name": "LayoutExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Layout to be set" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}SetLayoutResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}SetLayoutResponse", + "schema": { + "name": "SetLayoutResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "GetDisplayOptions", + "port_type": "DisplayPort", + "description": "The Display Options contain the supported layouts (LayoutOptions) and the decoding and encoding capabilities (CodingCapabilities) of the device. The GetDisplayOptions command returns both, Layout and Coding Capabilities, of a VideoOutput.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetDisplayOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetDisplayOptions", + "schema": { + "name": "GetDisplayOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Video Output whose options are requested" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetDisplayOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetDisplayOptionsResponse", + "schema": { + "name": "GetDisplayOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "LayoutOptions", + "type": "{http://www.onvif.org/ver10/schema}LayoutOptions", + "type_name": "LayoutOptions", + "definition": { + "kind": "complexType", + "name": "LayoutOptions", + "description": "The options supported for a display layout.", + "fields": [ + { + "name": "PaneLayoutOptions", + "type": "{http://www.onvif.org/ver10/schema}PaneLayoutOptions", + "type_name": "PaneLayoutOptions", + "definition": { + "kind": "complexType", + "name": "PaneLayoutOptions", + "description": "Description of a pane layout describing a complete display layout.", + "fields": [ + { + "name": "Area", + "type": "{http://www.onvif.org/ver10/schema}Rectangle", + "type_name": "Rectangle", + "definition": { + "kind": "complexType", + "name": "Rectangle", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "bottom", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "top", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "right", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "left", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of areas assembling a layout. Coordinate values are in the range [-1.0, 1.0]." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PaneOptionExtension", + "type_name": "PaneOptionExtension", + "definition": { + "kind": "complexType", + "name": "PaneOptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Lists the possible Pane Layouts of the Video Output" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}LayoutOptionsExtension", + "type_name": "LayoutOptionsExtension", + "definition": { + "kind": "complexType", + "name": "LayoutOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The LayoutOptions describe the fixed and predefined layouts of a device. If the device does\nnot offer fixed layouts and allows setting the layout free this element is empty." + }, + { + "name": "CodingCapabilities", + "type": "{http://www.onvif.org/ver10/schema}CodingCapabilities", + "type_name": "CodingCapabilities", + "definition": { + "kind": "complexType", + "name": "CodingCapabilities", + "description": "This type contains the Audio and Video coding capabilities of a display service.", + "fields": [ + { + "name": "AudioEncodingCapabilities", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfigurationOptions", + "type_name": "AudioEncoderConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfigurationOptions", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfigurationOption", + "type_name": "AudioEncoderConfigurationOption", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfigurationOption", + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The encoding used for audio data (either G.711, G.726 or AAC)." + }, + { + "name": "BitrateList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps for the specified Encoding." + }, + { + "name": "SampleRateList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported Sample Rates in kHz for the specified Encoding." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "list of supported AudioEncoderConfigurations" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device supports audio encoding this section describes the supported codecs and their configuration." + }, + { + "name": "AudioDecodingCapabilities", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfigurationOptions", + "type_name": "AudioDecoderConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfigurationOptions", + "fields": [ + { + "name": "AACDecOptions", + "type": "{http://www.onvif.org/ver10/schema}AACDecOptions", + "type_name": "AACDecOptions", + "definition": { + "kind": "complexType", + "name": "AACDecOptions", + "fields": [ + { + "name": "Bitrate", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps." + }, + { + "name": "SampleRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported sample rates in kHz" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode AAC encoded audio this section describes the supported configurations" + }, + { + "name": "G711DecOptions", + "type": "{http://www.onvif.org/ver10/schema}G711DecOptions", + "type_name": "G711DecOptions", + "definition": { + "kind": "complexType", + "name": "G711DecOptions", + "fields": [ + { + "name": "Bitrate", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps." + }, + { + "name": "SampleRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported sample rates in kHz" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode G711 encoded audio this section describes the supported configurations" + }, + { + "name": "G726DecOptions", + "type": "{http://www.onvif.org/ver10/schema}G726DecOptions", + "type_name": "G726DecOptions", + "definition": { + "kind": "complexType", + "name": "G726DecOptions", + "fields": [ + { + "name": "Bitrate", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps." + }, + { + "name": "SampleRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported sample rates in kHz" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode G726 encoded audio this section describes the supported configurations" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfigurationOptionsExtension", + "type_name": "AudioDecoderConfigurationOptionsExtension", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfigurationOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device supports audio decoding this section describes the supported codecs and their settings." + }, + { + "name": "VideoDecodingCapabilities", + "type": "{http://www.onvif.org/ver10/schema}VideoDecoderConfigurationOptions", + "type_name": "VideoDecoderConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "VideoDecoderConfigurationOptions", + "fields": [ + { + "name": "JpegDecOptions", + "type": "{http://www.onvif.org/ver10/schema}JpegDecOptions", + "type_name": "JpegDecOptions", + "definition": { + "kind": "complexType", + "name": "JpegDecOptions", + "fields": [ + { + "name": "ResolutionsAvailable", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported Jpeg Video Resolutions" + }, + { + "name": "SupportedInputBitrate", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported Jpeg bitrate range in kbps." + }, + { + "name": "SupportedFrameRate", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported Jpeg framerate range in fps" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode Jpeg streams this element describes the supported codecs and configurations" + }, + { + "name": "H264DecOptions", + "type": "{http://www.onvif.org/ver10/schema}H264DecOptions", + "type_name": "H264DecOptions", + "definition": { + "kind": "complexType", + "name": "H264DecOptions", + "fields": [ + { + "name": "ResolutionsAvailable", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported H.264 Video Resolutions" + }, + { + "name": "SupportedH264Profiles", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported H264 Profiles (either baseline, main, extended or high)." + }, + { + "name": "SupportedInputBitrate", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported H.264 bitrate range in kbps." + }, + { + "name": "SupportedFrameRate", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported H.264 framerate range in fps" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode H.264 streams this element describes the supported codecs and configurations" + }, + { + "name": "Mpeg4DecOptions", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4DecOptions", + "type_name": "Mpeg4DecOptions", + "definition": { + "kind": "complexType", + "name": "Mpeg4DecOptions", + "fields": [ + { + "name": "ResolutionsAvailable", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported Mpeg4 Video Resolutions" + }, + { + "name": "SupportedMpeg4Profiles", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported Mpeg4 Profiles (either SP or ASP)" + }, + { + "name": "SupportedInputBitrate", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported Mpeg4 bitrate range in kbps." + }, + { + "name": "SupportedFrameRate", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported Mpeg4 framerate range in fps" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode Mpeg4 streams this element describes the supported codecs and configurations" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoDecoderConfigurationOptionsExtension", + "type_name": "VideoDecoderConfigurationOptionsExtension", + "definition": { + "kind": "complexType", + "name": "VideoDecoderConfigurationOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This section describes the supported video codecs and their configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "decoding and encoding capabilities of the device" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "GetPaneConfigurations", + "port_type": "DisplayPort", + "description": "List all currently defined panes of a device for a specified video output (regardless if this pane is visible at a moment). A Pane is a display area on the monitor that is attached to a video output. A pane has a PaneConfiguration that describes which entities are associated with the pane. A client has to configure the pane according to the connection to be established by setting the AudioOutput and/or AudioSourceToken. If a Token is not set, the corresponding session will not be established.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurations", + "schema": { + "name": "GetPaneConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference Token of the Video Output whose Pane Configurations are requested" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurationsResponse", + "schema": { + "name": "GetPaneConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PaneConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PaneConfiguration", + "type_name": "PaneConfiguration", + "definition": { + "kind": "complexType", + "name": "PaneConfiguration", + "description": "Configuration of the streaming and coding settings of a Video window.", + "fields": [ + { + "name": "PaneName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional name of the pane configuration." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client\ncan retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service." + }, + { + "name": "AudioSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane.\nThe audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the\nDeviceIO service." + }, + { + "name": "AudioEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the audio encoder including codec, bitrate\nand sample rate." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A pointer to a Receiver that has the necessary information to receive\n\t\t\t\tdata from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the\n\t\t\t\tGetReceivers command of the Receiver Service." + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique identifier in the display device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of defined Panes of the specified VideoOutput. Each VideoOutput has at least one PaneConfiguration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "GetPaneConfiguration", + "port_type": "DisplayPort", + "description": "Retrieve the pane configuration for a pane token.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfiguration", + "schema": { + "name": "GetPaneConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference Token of the Video Output the requested pane belongs to" + }, + { + "name": "Pane", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference Token of the Pane whose Configuration is requested" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurationResponse", + "schema": { + "name": "GetPaneConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PaneConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PaneConfiguration", + "type_name": "PaneConfiguration", + "definition": { + "kind": "complexType", + "name": "PaneConfiguration", + "description": "Configuration of the streaming and coding settings of a Video window.", + "fields": [ + { + "name": "PaneName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional name of the pane configuration." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client\ncan retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service." + }, + { + "name": "AudioSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane.\nThe audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the\nDeviceIO service." + }, + { + "name": "AudioEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the audio encoder including codec, bitrate\nand sample rate." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A pointer to a Receiver that has the necessary information to receive\n\t\t\t\tdata from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the\n\t\t\t\tGetReceivers command of the Receiver Service." + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique identifier in the display device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "returns the configuration of the requested pane." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "SetPaneConfigurations", + "port_type": "DisplayPort", + "description": "Modify one or more configurations of the specified video output. This method will only modify the provided configurations and leave the others unchanged. Use DeletePaneConfiguration to remove pane configurations.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurations", + "schema": { + "name": "SetPaneConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the video output whose panes to set." + }, + { + "name": "PaneConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PaneConfiguration", + "type_name": "PaneConfiguration", + "definition": { + "kind": "complexType", + "name": "PaneConfiguration", + "description": "Configuration of the streaming and coding settings of a Video window.", + "fields": [ + { + "name": "PaneName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional name of the pane configuration." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client\ncan retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service." + }, + { + "name": "AudioSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane.\nThe audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the\nDeviceIO service." + }, + { + "name": "AudioEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the audio encoder including codec, bitrate\nand sample rate." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A pointer to a Receiver that has the necessary information to receive\n\t\t\t\tdata from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the\n\t\t\t\tGetReceivers command of the Receiver Service." + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique identifier in the display device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Pane Configuration to be set." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurationsResponse", + "schema": { + "name": "SetPaneConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "SetPaneConfiguration", + "port_type": "DisplayPort", + "description": "This command changes the configuration of the specified pane (tbd)", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfiguration", + "schema": { + "name": "SetPaneConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the video output whose panes to set." + }, + { + "name": "PaneConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PaneConfiguration", + "type_name": "PaneConfiguration", + "definition": { + "kind": "complexType", + "name": "PaneConfiguration", + "description": "Configuration of the streaming and coding settings of a Video window.", + "fields": [ + { + "name": "PaneName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional name of the pane configuration." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client\ncan retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service." + }, + { + "name": "AudioSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane.\nThe audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the\nDeviceIO service." + }, + { + "name": "AudioEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the audio encoder including codec, bitrate\nand sample rate." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A pointer to a Receiver that has the necessary information to receive\n\t\t\t\tdata from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the\n\t\t\t\tGetReceivers command of the Receiver Service." + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique identifier in the display device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Pane Configuration to be set." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurationResponse", + "schema": { + "name": "SetPaneConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "CreatePaneConfiguration", + "port_type": "DisplayPort", + "description": "Create a new pane configuration describing the streaming and coding settings for a display area. This optional method is only supported by devices that signal support of dynamic pane creation via their capabilities. The content of the Token field may be ignored by the device.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}CreatePaneConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}CreatePaneConfiguration", + "schema": { + "name": "CreatePaneConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the video output where the pane shall be created." + }, + { + "name": "PaneConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PaneConfiguration", + "type_name": "PaneConfiguration", + "definition": { + "kind": "complexType", + "name": "PaneConfiguration", + "description": "Configuration of the streaming and coding settings of a Video window.", + "fields": [ + { + "name": "PaneName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional name of the pane configuration." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client\ncan retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service." + }, + { + "name": "AudioSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane.\nThe audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the\nDeviceIO service." + }, + { + "name": "AudioEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the audio encoder including codec, bitrate\nand sample rate." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A pointer to a Receiver that has the necessary information to receive\n\t\t\t\tdata from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the\n\t\t\t\tGetReceivers command of the Receiver Service." + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique identifier in the display device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configuration of the pane to be created." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}CreatePaneConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}CreatePaneConfigurationResponse", + "schema": { + "name": "CreatePaneConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PaneToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the new pane configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "DeletePaneConfiguration", + "port_type": "DisplayPort", + "description": "Delete a pane configuration. A service must respond with an error if the pane configuration is in use by the current layout. This optional method is only supported by devices that signal support of dynamic pane creation via their capabilities.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}DeletePaneConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}DeletePaneConfiguration", + "schema": { + "name": "DeletePaneConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the video output where the pane shall be deleted." + }, + { + "name": "PaneToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the pane to be deleted." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}DeletePaneConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}DeletePaneConfigurationResponse", + "schema": { + "name": "DeletePaneConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/display/display.json b/docs/generated/wsdl/ver10/display/display.json new file mode 100644 index 00000000..5143af41 --- /dev/null +++ b/docs/generated/wsdl/ver10/display/display.json @@ -0,0 +1,3620 @@ +{ + "source": "ver10/display/display.wsdl", + "target_namespace": "http://www.onvif.org/ver10/display/wsdl", + "operations": [ + { + "name": "GetLayout", + "port_type": "DisplayPort", + "description": "Return the current layout of a video output. The Layout assigns a pane configuration to a certain area of the display. The layout settings directly affect a specific video output. The layout consists of a list of PaneConfigurations and their associated display areas.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetLayoutRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetLayout", + "schema": { + "name": "GetLayout", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Video Output whose Layout is requested" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetLayoutResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetLayoutResponse", + "schema": { + "name": "GetLayoutResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Layout", + "type": "{http://www.onvif.org/ver10/schema}Layout", + "type_name": "Layout", + "definition": { + "kind": "complexType", + "name": "Layout", + "description": "A layout describes a set of Video windows that are displayed simultaneously on a display.", + "fields": [ + { + "name": "PaneLayout", + "type": "{http://www.onvif.org/ver10/schema}PaneLayout", + "type_name": "PaneLayout", + "definition": { + "kind": "complexType", + "name": "PaneLayout", + "description": "A pane layout describes one Video window of a display. It links a pane configuration to a region of the screen.", + "fields": [ + { + "name": "Pane", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the configuration of the streaming and coding parameters." + }, + { + "name": "Area", + "type": "{http://www.onvif.org/ver10/schema}Rectangle", + "type_name": "Rectangle", + "definition": { + "kind": "complexType", + "name": "Rectangle", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "bottom", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "top", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "right", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "left", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Describes the location and size of the area on the monitor. The area coordinate values are expressed in normalized units [-1.0, 1.0]." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of panes assembling the display layout." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}LayoutExtension", + "type_name": "LayoutExtension", + "definition": { + "kind": "complexType", + "name": "LayoutExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current layout of the video output." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "SetLayout", + "port_type": "DisplayPort", + "description": "Change the layout of a display (e.g. change from single view to split screen view).The Layout assigns a pane configuration to a certain area of the display. The layout settings directly affect a specific video output. The layout consists of a list of PaneConfigurations and their associated display areas.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}SetLayoutRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}SetLayout", + "schema": { + "name": "SetLayout", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Video Output whose Layout shall be changed." + }, + { + "name": "Layout", + "type": "{http://www.onvif.org/ver10/schema}Layout", + "type_name": "Layout", + "definition": { + "kind": "complexType", + "name": "Layout", + "description": "A layout describes a set of Video windows that are displayed simultaneously on a display.", + "fields": [ + { + "name": "PaneLayout", + "type": "{http://www.onvif.org/ver10/schema}PaneLayout", + "type_name": "PaneLayout", + "definition": { + "kind": "complexType", + "name": "PaneLayout", + "description": "A pane layout describes one Video window of a display. It links a pane configuration to a region of the screen.", + "fields": [ + { + "name": "Pane", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the configuration of the streaming and coding parameters." + }, + { + "name": "Area", + "type": "{http://www.onvif.org/ver10/schema}Rectangle", + "type_name": "Rectangle", + "definition": { + "kind": "complexType", + "name": "Rectangle", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "bottom", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "top", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "right", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "left", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Describes the location and size of the area on the monitor. The area coordinate values are expressed in normalized units [-1.0, 1.0]." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of panes assembling the display layout." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}LayoutExtension", + "type_name": "LayoutExtension", + "definition": { + "kind": "complexType", + "name": "LayoutExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Layout to be set" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}SetLayoutResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}SetLayoutResponse", + "schema": { + "name": "SetLayoutResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "GetDisplayOptions", + "port_type": "DisplayPort", + "description": "The Display Options contain the supported layouts (LayoutOptions) and the decoding and encoding capabilities (CodingCapabilities) of the device. The GetDisplayOptions command returns both, Layout and Coding Capabilities, of a VideoOutput.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetDisplayOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetDisplayOptions", + "schema": { + "name": "GetDisplayOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Video Output whose options are requested" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetDisplayOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetDisplayOptionsResponse", + "schema": { + "name": "GetDisplayOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "LayoutOptions", + "type": "{http://www.onvif.org/ver10/schema}LayoutOptions", + "type_name": "LayoutOptions", + "definition": { + "kind": "complexType", + "name": "LayoutOptions", + "description": "The options supported for a display layout.", + "fields": [ + { + "name": "PaneLayoutOptions", + "type": "{http://www.onvif.org/ver10/schema}PaneLayoutOptions", + "type_name": "PaneLayoutOptions", + "definition": { + "kind": "complexType", + "name": "PaneLayoutOptions", + "description": "Description of a pane layout describing a complete display layout.", + "fields": [ + { + "name": "Area", + "type": "{http://www.onvif.org/ver10/schema}Rectangle", + "type_name": "Rectangle", + "definition": { + "kind": "complexType", + "name": "Rectangle", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "bottom", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "top", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "right", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "left", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of areas assembling a layout. Coordinate values are in the range [-1.0, 1.0]." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PaneOptionExtension", + "type_name": "PaneOptionExtension", + "definition": { + "kind": "complexType", + "name": "PaneOptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Lists the possible Pane Layouts of the Video Output" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}LayoutOptionsExtension", + "type_name": "LayoutOptionsExtension", + "definition": { + "kind": "complexType", + "name": "LayoutOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The LayoutOptions describe the fixed and predefined layouts of a device. If the device does\nnot offer fixed layouts and allows setting the layout free this element is empty." + }, + { + "name": "CodingCapabilities", + "type": "{http://www.onvif.org/ver10/schema}CodingCapabilities", + "type_name": "CodingCapabilities", + "definition": { + "kind": "complexType", + "name": "CodingCapabilities", + "description": "This type contains the Audio and Video coding capabilities of a display service.", + "fields": [ + { + "name": "AudioEncodingCapabilities", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfigurationOptions", + "type_name": "AudioEncoderConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfigurationOptions", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfigurationOption", + "type_name": "AudioEncoderConfigurationOption", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfigurationOption", + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The encoding used for audio data (either G.711, G.726 or AAC)." + }, + { + "name": "BitrateList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps for the specified Encoding." + }, + { + "name": "SampleRateList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported Sample Rates in kHz for the specified Encoding." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "list of supported AudioEncoderConfigurations" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device supports audio encoding this section describes the supported codecs and their configuration." + }, + { + "name": "AudioDecodingCapabilities", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfigurationOptions", + "type_name": "AudioDecoderConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfigurationOptions", + "fields": [ + { + "name": "AACDecOptions", + "type": "{http://www.onvif.org/ver10/schema}AACDecOptions", + "type_name": "AACDecOptions", + "definition": { + "kind": "complexType", + "name": "AACDecOptions", + "fields": [ + { + "name": "Bitrate", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps." + }, + { + "name": "SampleRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported sample rates in kHz" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode AAC encoded audio this section describes the supported configurations" + }, + { + "name": "G711DecOptions", + "type": "{http://www.onvif.org/ver10/schema}G711DecOptions", + "type_name": "G711DecOptions", + "definition": { + "kind": "complexType", + "name": "G711DecOptions", + "fields": [ + { + "name": "Bitrate", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps." + }, + { + "name": "SampleRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported sample rates in kHz" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode G711 encoded audio this section describes the supported configurations" + }, + { + "name": "G726DecOptions", + "type": "{http://www.onvif.org/ver10/schema}G726DecOptions", + "type_name": "G726DecOptions", + "definition": { + "kind": "complexType", + "name": "G726DecOptions", + "fields": [ + { + "name": "Bitrate", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps." + }, + { + "name": "SampleRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported sample rates in kHz" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode G726 encoded audio this section describes the supported configurations" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfigurationOptionsExtension", + "type_name": "AudioDecoderConfigurationOptionsExtension", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfigurationOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device supports audio decoding this section describes the supported codecs and their settings." + }, + { + "name": "VideoDecodingCapabilities", + "type": "{http://www.onvif.org/ver10/schema}VideoDecoderConfigurationOptions", + "type_name": "VideoDecoderConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "VideoDecoderConfigurationOptions", + "fields": [ + { + "name": "JpegDecOptions", + "type": "{http://www.onvif.org/ver10/schema}JpegDecOptions", + "type_name": "JpegDecOptions", + "definition": { + "kind": "complexType", + "name": "JpegDecOptions", + "fields": [ + { + "name": "ResolutionsAvailable", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported Jpeg Video Resolutions" + }, + { + "name": "SupportedInputBitrate", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported Jpeg bitrate range in kbps." + }, + { + "name": "SupportedFrameRate", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported Jpeg framerate range in fps" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode Jpeg streams this element describes the supported codecs and configurations" + }, + { + "name": "H264DecOptions", + "type": "{http://www.onvif.org/ver10/schema}H264DecOptions", + "type_name": "H264DecOptions", + "definition": { + "kind": "complexType", + "name": "H264DecOptions", + "fields": [ + { + "name": "ResolutionsAvailable", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported H.264 Video Resolutions" + }, + { + "name": "SupportedH264Profiles", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported H264 Profiles (either baseline, main, extended or high)." + }, + { + "name": "SupportedInputBitrate", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported H.264 bitrate range in kbps." + }, + { + "name": "SupportedFrameRate", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported H.264 framerate range in fps" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode H.264 streams this element describes the supported codecs and configurations" + }, + { + "name": "Mpeg4DecOptions", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4DecOptions", + "type_name": "Mpeg4DecOptions", + "definition": { + "kind": "complexType", + "name": "Mpeg4DecOptions", + "fields": [ + { + "name": "ResolutionsAvailable", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported Mpeg4 Video Resolutions" + }, + { + "name": "SupportedMpeg4Profiles", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported Mpeg4 Profiles (either SP or ASP)" + }, + { + "name": "SupportedInputBitrate", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported Mpeg4 bitrate range in kbps." + }, + { + "name": "SupportedFrameRate", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported Mpeg4 framerate range in fps" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode Mpeg4 streams this element describes the supported codecs and configurations" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoDecoderConfigurationOptionsExtension", + "type_name": "VideoDecoderConfigurationOptionsExtension", + "definition": { + "kind": "complexType", + "name": "VideoDecoderConfigurationOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This section describes the supported video codecs and their configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "decoding and encoding capabilities of the device" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "GetPaneConfigurations", + "port_type": "DisplayPort", + "description": "List all currently defined panes of a device for a specified video output (regardless if this pane is visible at a moment). A Pane is a display area on the monitor that is attached to a video output. A pane has a PaneConfiguration that describes which entities are associated with the pane. A client has to configure the pane according to the connection to be established by setting the AudioOutput and/or AudioSourceToken. If a Token is not set, the corresponding session will not be established.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurations", + "schema": { + "name": "GetPaneConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference Token of the Video Output whose Pane Configurations are requested" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurationsResponse", + "schema": { + "name": "GetPaneConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PaneConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PaneConfiguration", + "type_name": "PaneConfiguration", + "definition": { + "kind": "complexType", + "name": "PaneConfiguration", + "description": "Configuration of the streaming and coding settings of a Video window.", + "fields": [ + { + "name": "PaneName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional name of the pane configuration." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client\ncan retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service." + }, + { + "name": "AudioSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane.\nThe audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the\nDeviceIO service." + }, + { + "name": "AudioEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the audio encoder including codec, bitrate\nand sample rate." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A pointer to a Receiver that has the necessary information to receive\n\t\t\t\tdata from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the\n\t\t\t\tGetReceivers command of the Receiver Service." + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique identifier in the display device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of defined Panes of the specified VideoOutput. Each VideoOutput has at least one PaneConfiguration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "GetPaneConfiguration", + "port_type": "DisplayPort", + "description": "Retrieve the pane configuration for a pane token.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfiguration", + "schema": { + "name": "GetPaneConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference Token of the Video Output the requested pane belongs to" + }, + { + "name": "Pane", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference Token of the Pane whose Configuration is requested" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}GetPaneConfigurationResponse", + "schema": { + "name": "GetPaneConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PaneConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PaneConfiguration", + "type_name": "PaneConfiguration", + "definition": { + "kind": "complexType", + "name": "PaneConfiguration", + "description": "Configuration of the streaming and coding settings of a Video window.", + "fields": [ + { + "name": "PaneName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional name of the pane configuration." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client\ncan retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service." + }, + { + "name": "AudioSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane.\nThe audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the\nDeviceIO service." + }, + { + "name": "AudioEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the audio encoder including codec, bitrate\nand sample rate." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A pointer to a Receiver that has the necessary information to receive\n\t\t\t\tdata from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the\n\t\t\t\tGetReceivers command of the Receiver Service." + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique identifier in the display device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "returns the configuration of the requested pane." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "SetPaneConfigurations", + "port_type": "DisplayPort", + "description": "Modify one or more configurations of the specified video output. This method will only modify the provided configurations and leave the others unchanged. Use DeletePaneConfiguration to remove pane configurations.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurations", + "schema": { + "name": "SetPaneConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the video output whose panes to set." + }, + { + "name": "PaneConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PaneConfiguration", + "type_name": "PaneConfiguration", + "definition": { + "kind": "complexType", + "name": "PaneConfiguration", + "description": "Configuration of the streaming and coding settings of a Video window.", + "fields": [ + { + "name": "PaneName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional name of the pane configuration." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client\ncan retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service." + }, + { + "name": "AudioSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane.\nThe audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the\nDeviceIO service." + }, + { + "name": "AudioEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the audio encoder including codec, bitrate\nand sample rate." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A pointer to a Receiver that has the necessary information to receive\n\t\t\t\tdata from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the\n\t\t\t\tGetReceivers command of the Receiver Service." + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique identifier in the display device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Pane Configuration to be set." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurationsResponse", + "schema": { + "name": "SetPaneConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "SetPaneConfiguration", + "port_type": "DisplayPort", + "description": "This command changes the configuration of the specified pane (tbd)", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfiguration", + "schema": { + "name": "SetPaneConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the video output whose panes to set." + }, + { + "name": "PaneConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PaneConfiguration", + "type_name": "PaneConfiguration", + "definition": { + "kind": "complexType", + "name": "PaneConfiguration", + "description": "Configuration of the streaming and coding settings of a Video window.", + "fields": [ + { + "name": "PaneName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional name of the pane configuration." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client\ncan retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service." + }, + { + "name": "AudioSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane.\nThe audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the\nDeviceIO service." + }, + { + "name": "AudioEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the audio encoder including codec, bitrate\nand sample rate." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A pointer to a Receiver that has the necessary information to receive\n\t\t\t\tdata from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the\n\t\t\t\tGetReceivers command of the Receiver Service." + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique identifier in the display device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Pane Configuration to be set." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}SetPaneConfigurationResponse", + "schema": { + "name": "SetPaneConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "CreatePaneConfiguration", + "port_type": "DisplayPort", + "description": "Create a new pane configuration describing the streaming and coding settings for a display area. This optional method is only supported by devices that signal support of dynamic pane creation via their capabilities.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}CreatePaneConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}CreatePaneConfiguration", + "schema": { + "name": "CreatePaneConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the video output where the pane shall be created." + }, + { + "name": "PaneConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PaneConfiguration", + "type_name": "PaneConfiguration", + "definition": { + "kind": "complexType", + "name": "PaneConfiguration", + "description": "Configuration of the streaming and coding settings of a Video window.", + "fields": [ + { + "name": "PaneName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional name of the pane configuration." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client\ncan retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service." + }, + { + "name": "AudioSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane.\nThe audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the\nDeviceIO service." + }, + { + "name": "AudioEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the audio encoder including codec, bitrate\nand sample rate." + }, + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A pointer to a Receiver that has the necessary information to receive\n\t\t\t\tdata from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the\n\t\t\t\tGetReceivers command of the Receiver Service." + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique identifier in the display device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configuration of the pane to be created." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}CreatePaneConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}CreatePaneConfigurationResponse", + "schema": { + "name": "CreatePaneConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PaneToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the new pane configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + }, + { + "name": "DeletePaneConfiguration", + "port_type": "DisplayPort", + "description": "Delete a pane configuration. A service must respond with an error if the pane configuration is in use by the current layout. This optional method is only supported by devices that signal support of dynamic pane creation via their capabilities.", + "input": { + "message": "{http://www.onvif.org/ver10/display/wsdl}DeletePaneConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}DeletePaneConfiguration", + "schema": { + "name": "DeletePaneConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoOutput", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the video output where the pane shall be deleted." + }, + { + "name": "PaneToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the pane to be deleted." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/display/wsdl}DeletePaneConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/display/wsdl}DeletePaneConfigurationResponse", + "schema": { + "name": "DeletePaneConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DisplayBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/events/wsdl/bw-2-vs-mod.json b/docs/generated/wsdl/ver10/events/wsdl/bw-2-vs-mod.json new file mode 100644 index 00000000..616b3236 --- /dev/null +++ b/docs/generated/wsdl/ver10/events/wsdl/bw-2-vs-mod.json @@ -0,0 +1,2077 @@ +{ + "source": "ver10/events/wsdl/bw-2-vs-mod.wsdl", + "target_namespace": "http://docs.oasis-open.org/wsn/bw-2", + "operations": [ + { + "name": "Notify", + "port_type": "NotificationConsumer", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}Notify", + "parts": [ + { + "name": "Notify", + "element": "{http://docs.oasis-open.org/wsn/b-2}Notify", + "schema": { + "name": "Notify", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NotificationMessage", + "type": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessageHolderType", + "type_name": "NotificationMessageHolderType", + "definition": { + "kind": "complexType", + "name": "NotificationMessageHolderType", + "fields": [ + { + "name": "SubscriptionReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}SubscriptionReference" + }, + { + "name": "Topic", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}Topic" + }, + { + "name": "ProducerReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}ProducerReference" + }, + { + "name": "Message", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessage" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": null, + "parts": [] + }, + "faults": [], + "binding": "NotificationConsumerBinding" + }, + { + "name": "Subscribe", + "port_type": "NotificationProducer", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}SubscribeRequest", + "parts": [ + { + "name": "SubscribeRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}Subscribe", + "schema": { + "name": "Subscribe", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConsumerReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "InitialTerminationTime", + "type": "{http://docs.oasis-open.org/wsn/b-2}AbsoluteOrRelativeTimeType", + "type_name": "AbsoluteOrRelativeTimeType", + "definition": { + "kind": "simpleType", + "name": "AbsoluteOrRelativeTimeType", + "member_types": [ + "{http://www.w3.org/2001/XMLSchema}dateTime", + "{http://www.w3.org/2001/XMLSchema}duration" + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": true + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}SubscribeResponse", + "parts": [ + { + "name": "SubscribeResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}SubscribeResponse", + "schema": { + "name": "SubscribeResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SubscriptionReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "CurrentTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}CurrentTime" + }, + { + "name": "TerminationTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}TerminationTime" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "InvalidFilterFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidFilterFault" + }, + { + "name": "TopicExpressionDialectUnknownFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}TopicExpressionDialectUnknownFault" + }, + { + "name": "InvalidTopicExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidTopicExpressionFault" + }, + { + "name": "TopicNotSupportedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}TopicNotSupportedFault" + }, + { + "name": "InvalidProducerPropertiesExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidProducerPropertiesExpressionFault" + }, + { + "name": "InvalidMessageContentExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidMessageContentExpressionFault" + }, + { + "name": "UnacceptableInitialTerminationTimeFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnacceptableInitialTerminationTimeFault" + }, + { + "name": "UnrecognizedPolicyRequestFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnrecognizedPolicyRequestFault" + }, + { + "name": "UnsupportedPolicyRequestFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsupportedPolicyRequestFault" + }, + { + "name": "NotifyMessageNotSupportedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}NotifyMessageNotSupportedFault" + }, + { + "name": "SubscribeCreationFailedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}SubscribeCreationFailedFault" + } + ], + "binding": "NotificationProducerBinding" + }, + { + "name": "GetCurrentMessage", + "port_type": "NotificationProducer", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}GetCurrentMessageRequest", + "parts": [ + { + "name": "GetCurrentMessageRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}GetCurrentMessage", + "schema": { + "name": "GetCurrentMessage", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Topic", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}GetCurrentMessageResponse", + "parts": [ + { + "name": "GetCurrentMessageResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}GetCurrentMessageResponse", + "schema": { + "name": "GetCurrentMessageResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "TopicExpressionDialectUnknownFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}TopicExpressionDialectUnknownFault" + }, + { + "name": "InvalidTopicExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidTopicExpressionFault" + }, + { + "name": "TopicNotSupportedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}TopicNotSupportedFault" + }, + { + "name": "NoCurrentMessageOnTopicFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}NoCurrentMessageOnTopicFault" + }, + { + "name": "MultipleTopicsSpecifiedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}MultipleTopicsSpecifiedFault" + } + ], + "binding": "NotificationProducerBinding" + }, + { + "name": "GetMessages", + "port_type": "PullPoint", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}GetMessagesRequest", + "parts": [ + { + "name": "GetMessagesRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}GetMessages", + "schema": { + "name": "GetMessages", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "MaximumNumber", + "type": "{http://www.w3.org/2001/XMLSchema}nonNegativeInteger", + "type_name": "nonNegativeInteger", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}GetMessagesResponse", + "parts": [ + { + "name": "GetMessagesResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}GetMessagesResponse", + "schema": { + "name": "GetMessagesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NotificationMessage", + "type": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessageHolderType", + "type_name": "NotificationMessageHolderType", + "definition": { + "kind": "complexType", + "name": "NotificationMessageHolderType", + "fields": [ + { + "name": "SubscriptionReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}SubscriptionReference" + }, + { + "name": "Topic", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}Topic" + }, + { + "name": "ProducerReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}ProducerReference" + }, + { + "name": "Message", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessage" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnableToGetMessagesFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnableToGetMessagesFault" + } + ], + "binding": "PullPointBinding" + }, + { + "name": "DestroyPullPoint", + "port_type": "PullPoint", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}DestroyPullPointRequest", + "parts": [ + { + "name": "DestroyPullPointRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}DestroyPullPoint", + "schema": { + "name": "DestroyPullPoint", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}DestroyPullPointResponse", + "parts": [ + { + "name": "DestroyPullPointResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}DestroyPullPointResponse", + "schema": { + "name": "DestroyPullPointResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnableToDestroyPullPointFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnableToDestroyPullPointFault" + } + ], + "binding": "PullPointBinding" + }, + { + "name": "Notify", + "port_type": "PullPoint", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}Notify", + "parts": [ + { + "name": "Notify", + "element": "{http://docs.oasis-open.org/wsn/b-2}Notify", + "schema": { + "name": "Notify", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NotificationMessage", + "type": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessageHolderType", + "type_name": "NotificationMessageHolderType", + "definition": { + "kind": "complexType", + "name": "NotificationMessageHolderType", + "fields": [ + { + "name": "SubscriptionReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}SubscriptionReference" + }, + { + "name": "Topic", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}Topic" + }, + { + "name": "ProducerReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}ProducerReference" + }, + { + "name": "Message", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessage" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": null, + "parts": [] + }, + "faults": [], + "binding": "PullPointBinding" + }, + { + "name": "CreatePullPoint", + "port_type": "CreatePullPointPortType", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}CreatePullPointRequest", + "parts": [ + { + "name": "CreatePullPointRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}CreatePullPoint", + "schema": { + "name": "CreatePullPoint", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}CreatePullPointResponse", + "parts": [ + { + "name": "CreatePullPointResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}CreatePullPointResponse", + "schema": { + "name": "CreatePullPointResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PullPoint", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "UnableToCreatePullPointFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnableToCreatePullPointFault" + } + ] + }, + { + "name": "Renew", + "port_type": "SubscriptionManager", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}RenewRequest", + "parts": [ + { + "name": "RenewRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}Renew", + "schema": { + "name": "Renew", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TerminationTime", + "type": "{http://docs.oasis-open.org/wsn/b-2}AbsoluteOrRelativeTimeType", + "type_name": "AbsoluteOrRelativeTimeType", + "definition": { + "kind": "simpleType", + "name": "AbsoluteOrRelativeTimeType", + "member_types": [ + "{http://www.w3.org/2001/XMLSchema}dateTime", + "{http://www.w3.org/2001/XMLSchema}duration" + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": true + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}RenewResponse", + "parts": [ + { + "name": "RenewResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}RenewResponse", + "schema": { + "name": "RenewResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TerminationTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}TerminationTime" + }, + { + "name": "CurrentTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}CurrentTime" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnacceptableTerminationTimeFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnacceptableTerminationTimeFault" + } + ], + "binding": "SubscriptionManagerBinding" + }, + { + "name": "Unsubscribe", + "port_type": "SubscriptionManager", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsubscribeRequest", + "parts": [ + { + "name": "UnsubscribeRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}Unsubscribe", + "schema": { + "name": "Unsubscribe", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsubscribeResponse", + "parts": [ + { + "name": "UnsubscribeResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}UnsubscribeResponse", + "schema": { + "name": "UnsubscribeResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnableToDestroySubscriptionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnableToDestroySubscriptionFault" + } + ], + "binding": "SubscriptionManagerBinding" + }, + { + "name": "Renew", + "port_type": "PausableSubscriptionManager", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}RenewRequest", + "parts": [ + { + "name": "RenewRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}Renew", + "schema": { + "name": "Renew", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TerminationTime", + "type": "{http://docs.oasis-open.org/wsn/b-2}AbsoluteOrRelativeTimeType", + "type_name": "AbsoluteOrRelativeTimeType", + "definition": { + "kind": "simpleType", + "name": "AbsoluteOrRelativeTimeType", + "member_types": [ + "{http://www.w3.org/2001/XMLSchema}dateTime", + "{http://www.w3.org/2001/XMLSchema}duration" + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": true + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}RenewResponse", + "parts": [ + { + "name": "RenewResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}RenewResponse", + "schema": { + "name": "RenewResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TerminationTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}TerminationTime" + }, + { + "name": "CurrentTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}CurrentTime" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnacceptableTerminationTimeFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnacceptableTerminationTimeFault" + } + ], + "binding": "PausableSubscriptionManagerBinding" + }, + { + "name": "Unsubscribe", + "port_type": "PausableSubscriptionManager", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsubscribeRequest", + "parts": [ + { + "name": "UnsubscribeRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}Unsubscribe", + "schema": { + "name": "Unsubscribe", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsubscribeResponse", + "parts": [ + { + "name": "UnsubscribeResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}UnsubscribeResponse", + "schema": { + "name": "UnsubscribeResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnableToDestroySubscriptionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnableToDestroySubscriptionFault" + } + ], + "binding": "PausableSubscriptionManagerBinding" + }, + { + "name": "PauseSubscription", + "port_type": "PausableSubscriptionManager", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}PauseSubscriptionRequest", + "parts": [ + { + "name": "PauseSubscriptionRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}PauseSubscription", + "schema": { + "name": "PauseSubscription", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}PauseSubscriptionResponse", + "parts": [ + { + "name": "PauseSubscriptionResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}PauseSubscriptionResponse", + "schema": { + "name": "PauseSubscriptionResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "PauseFailedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}PauseFailedFault" + } + ], + "binding": "PausableSubscriptionManagerBinding" + }, + { + "name": "ResumeSubscription", + "port_type": "PausableSubscriptionManager", + "description": null, + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}ResumeSubscriptionRequest", + "parts": [ + { + "name": "ResumeSubscriptionRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}ResumeSubscription", + "schema": { + "name": "ResumeSubscription", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}ResumeSubscriptionResponse", + "parts": [ + { + "name": "ResumeSubscriptionResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}ResumeSubscriptionResponse", + "schema": { + "name": "ResumeSubscriptionResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "ResumeFailedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}ResumeFailedFault" + } + ], + "binding": "PausableSubscriptionManagerBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/events/wsdl/event-vs.json b/docs/generated/wsdl/ver10/events/wsdl/event-vs.json new file mode 100644 index 00000000..86b8cb65 --- /dev/null +++ b/docs/generated/wsdl/ver10/events/wsdl/event-vs.json @@ -0,0 +1,1509 @@ +{ + "source": "ver10/events/wsdl/event-vs.wsdl", + "target_namespace": "http://www.onvif.org/ver10/events/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "EventPortType", + "description": "Returns the capabilities of the event service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/events/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "WSSubscriptionPolicySupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that the WS Subscription policy is supported." + }, + { + "use": "optional", + "name": "WSPausableSubscriptionManagerInterfaceSupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that the WS Pausable Subscription Manager Interface is supported." + }, + { + "use": "optional", + "name": "MaxNotificationProducers", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of supported notification producers as defined by WS-BaseNotification." + }, + { + "use": "optional", + "name": "MaxPullPoints", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum supported number of notification pull points." + }, + { + "use": "optional", + "name": "PersistentNotificationStorage", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication if the device supports persistent notification storage." + }, + { + "use": "optional", + "name": "EventBrokerProtocols", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "A space separated list of supported event broker protocols as defined by the tev:EventBrokerProtocol datatype." + }, + { + "use": "optional", + "name": "MaxEventBrokers", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maxiumum number of event broker configurations that can be added to the device." + }, + { + "use": "optional", + "name": "MetadataOverMQTT", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that metadata streaming over MQTT is supported" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the event service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "EventBinding" + }, + { + "name": "CreatePullPointSubscription", + "port_type": "EventPortType", + "description": "This method returns a PullPointSubscription that can be polled using PullMessages. This message contains the same elements as the SubscriptionRequest of the WS-BaseNotification without the ConsumerReference. If no Filter is specified the pullpoint notifies all occurring events to the client. This method is mandatory.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}CreatePullPointSubscriptionRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}CreatePullPointSubscription", + "schema": { + "name": "CreatePullPointSubscription", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional XPATH expression to select specific topics." + }, + { + "name": "InitialTerminationTime", + "type": "{http://docs.oasis-open.org/wsn/b-2}AbsoluteOrRelativeTimeType", + "type_name": "AbsoluteOrRelativeTimeType", + "definition": { + "kind": "simpleType", + "name": "AbsoluteOrRelativeTimeType", + "member_types": [ + "{http://www.w3.org/2001/XMLSchema}dateTime", + "{http://www.w3.org/2001/XMLSchema}duration" + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": true, + "description": "Initial termination time." + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Refer to Web Services Base Notification 1.3 (WS-BaseNotification)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}CreatePullPointSubscriptionResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}CreatePullPointSubscriptionResponse", + "schema": { + "name": "CreatePullPointSubscriptionResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SubscriptionReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Endpoint reference of the subscription to be used for pulling the messages." + }, + { + "name": "CurrentTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}CurrentTime", + "description": "Current time of the device for synchronization purposes." + }, + { + "name": "TerminationTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}TerminationTime", + "description": "Date time when the PullPoint will be shut down without further pull requests." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "InvalidFilterFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidFilterFault" + }, + { + "name": "TopicExpressionDialectUnknownFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}TopicExpressionDialectUnknownFault" + }, + { + "name": "InvalidTopicExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidTopicExpressionFault" + }, + { + "name": "TopicNotSupportedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}TopicNotSupportedFault" + }, + { + "name": "InvalidProducerPropertiesExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidProducerPropertiesExpressionFault" + }, + { + "name": "InvalidMessageContentExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidMessageContentExpressionFault" + }, + { + "name": "UnacceptableInitialTerminationTimeFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnacceptableInitialTerminationTimeFault" + }, + { + "name": "UnrecognizedPolicyRequestFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnrecognizedPolicyRequestFault" + }, + { + "name": "UnsupportedPolicyRequestFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsupportedPolicyRequestFault" + }, + { + "name": "NotifyMessageNotSupportedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}NotifyMessageNotSupportedFault" + }, + { + "name": "SubscribeCreationFailedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}SubscribeCreationFailedFault" + } + ], + "binding": "EventBinding" + }, + { + "name": "GetEventProperties", + "port_type": "EventPortType", + "description": "The WS-BaseNotification specification defines a set of OPTIONAL WS-ResouceProperties. This specification does not require the implementation of the WS-ResourceProperty interface. Instead, the subsequent direct interface shall be implemented by an ONVIF compliant device in order to provide information about the FilterDialects, Schema files and topics supported by the device.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}GetEventPropertiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}GetEventProperties", + "schema": { + "name": "GetEventProperties", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}GetEventPropertiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}GetEventPropertiesResponse", + "schema": { + "name": "GetEventPropertiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TopicNamespaceLocation", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of topic namespaces supported." + }, + { + "name": "FixedTopicSet", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "default": "true", + "ref": "{http://docs.oasis-open.org/wsn/b-2}FixedTopicSet", + "description": "True when topicset is fixed for all times." + }, + { + "name": "TopicSet", + "type": "{http://docs.oasis-open.org/wsn/t-1}TopicSetType", + "type_name": "TopicSetType", + "definition": { + "kind": "complexType", + "name": "TopicSetType", + "base": "{http://docs.oasis-open.org/wsn/t-1}ExtensibleDocumented", + "base_definition": { + "kind": "complexType", + "name": "ExtensibleDocumented", + "fields": [ + { + "name": "documentation", + "type": "{http://docs.oasis-open.org/wsn/t-1}Documentation", + "type_name": "Documentation", + "definition": { + "kind": "complexType", + "name": "Documentation", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/t-1}TopicSet", + "description": "Set of topics supported." + }, + { + "name": "TopicExpressionDialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionDialect", + "description": "Defines the XPath expression syntax supported for matching topic expressions.
\n\t\t\t\t\t\t\tThe following TopicExpressionDialects are mandatory for an ONVIF compliant device :\n\t\t\t\t\t\t\t
    \n\t\t\t\t\t\t\t\t\t\t
  • http://docs.oasis-open.org/wsn/t-1/TopicExpression/Concrete
    • \n\t\t\t\t\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tev/topicExpression/ConcreteSet.
    • \n\t\t\t\t\t\t\t\t\t
" + }, + { + "name": "MessageContentFilterDialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Defines the XPath function set supported for message content filtering.
\n\t\t\t\t\t\tThe following MessageContentFilterDialects should be returned if a device supports the message content filtering:\n\t\t\t\t\t\t\t
    \n\t\t\t\t\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tev/messageContentFilter/ItemFilter.
    • \n\t\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tA device that does not support any MessageContentFilterDialect returns a single empty url." + }, + { + "name": "ProducerPropertiesFilterDialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional ProducerPropertiesDialects. Refer to Web Services Base Notification 1.3 (WS-BaseNotification) for advanced filtering." + }, + { + "name": "MessageContentSchemaLocation", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Message Content Description Language allows referencing\n\t\t\t\t\t\t\tof vendor-specific types. In order to ease the integration of such types into a client application,\n\t\t\t\t\t\t\tthe GetEventPropertiesResponse shall list all URI locations to schema files whose types are\n\t\t\t\t\t\t\tused in the description of notifications, with MessageContentSchemaLocation elements.
\n\t\t\t\t\t\t\tThis list shall at least contain the URI of the ONVIF schema file." + } + ], + "any": { + "namespace": "##other", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "EventBinding" + }, + { + "name": "AddEventBroker", + "port_type": "EventPortType", + "description": "The AddEventBroker command allows an ONVIF client to add an event broker configuration to device to enable ONVIF events to be transferred to an event broker. If an existing event broker configuration already exists with the same Address, the existing configuration shall be modified.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}AddEventBrokerRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}AddEventBroker", + "schema": { + "name": "AddEventBroker", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "EventBroker", + "type": "{http://www.onvif.org/ver10/events/wsdl}EventBrokerConfig", + "type_name": "EventBrokerConfig", + "definition": { + "kind": "complexType", + "name": "EventBrokerConfig", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Event broker address in the format \"scheme://host:port[/resource]\". The supported schemes shall be returned by the EventBrokerProtocols capability. The resource part of the URL is only valid when using websocket. The Address must be unique." + }, + { + "name": "TopicPrefix", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix that will be prepended to all topics before they are published. This is used to make published topics unique for each device. TopicPrefix is not allowed to be empty." + }, + { + "name": "UserName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User name for the event broker." + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Password for the event broker. Password shall not be included when returned with GetEventBrokers." + }, + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional certificate ID in the key store pointing to a client certificate to be used for authenticating the device at the message broker." + }, + { + "name": "PublishFilter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Concrete Topic Expression to select specific event topics to publish." + }, + { + "name": "QoS", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Quality of service level to use when publishing. This defines the guarantee of delivery for a specific message: 0 = At most once, 1 = At least once, 2 = Exactly once." + }, + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Current connection status (see tev:ConnectionStatus for possible values)." + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certification path validation policy used to validate the broker certificate. In case encryption is used but no validation policy is specified, the device shall not validate the broker certificate." + }, + { + "name": "MetadataFilter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Concrete Topic Expression to select specific metadata topics to publish." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}AddEventBrokerResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}AddEventBrokerResponse", + "schema": { + "name": "AddEventBrokerResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "EventBinding" + }, + { + "name": "DeleteEventBroker", + "port_type": "EventPortType", + "description": "The DeleteEventBroker allows an ONVIF client to delete an event broker configuration from an ONVIF device.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}DeleteEventBrokerRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}DeleteEventBroker", + "schema": { + "name": "DeleteEventBroker", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}DeleteEventBrokerResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}DeleteEventBrokerResponse", + "schema": { + "name": "DeleteEventBrokerResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "EventBinding" + }, + { + "name": "GetEventBrokers", + "port_type": "EventPortType", + "description": "The GetEventBrokers command lets a client retrieve event broker configurations from the device.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}GetEventBrokersRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}GetEventBrokers", + "schema": { + "name": "GetEventBrokers", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}GetEventBrokersResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}GetEventBrokersResponse", + "schema": { + "name": "GetEventBrokersResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "EventBroker", + "type": "{http://www.onvif.org/ver10/events/wsdl}EventBrokerConfig", + "type_name": "EventBrokerConfig", + "definition": { + "kind": "complexType", + "name": "EventBrokerConfig", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Event broker address in the format \"scheme://host:port[/resource]\". The supported schemes shall be returned by the EventBrokerProtocols capability. The resource part of the URL is only valid when using websocket. The Address must be unique." + }, + { + "name": "TopicPrefix", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix that will be prepended to all topics before they are published. This is used to make published topics unique for each device. TopicPrefix is not allowed to be empty." + }, + { + "name": "UserName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User name for the event broker." + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Password for the event broker. Password shall not be included when returned with GetEventBrokers." + }, + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional certificate ID in the key store pointing to a client certificate to be used for authenticating the device at the message broker." + }, + { + "name": "PublishFilter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Concrete Topic Expression to select specific event topics to publish." + }, + { + "name": "QoS", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Quality of service level to use when publishing. This defines the guarantee of delivery for a specific message: 0 = At most once, 1 = At least once, 2 = Exactly once." + }, + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Current connection status (see tev:ConnectionStatus for possible values)." + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certification path validation policy used to validate the broker certificate. In case encryption is used but no validation policy is specified, the device shall not validate the broker certificate." + }, + { + "name": "MetadataFilter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Concrete Topic Expression to select specific metadata topics to publish." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "EventBinding" + }, + { + "name": "PullMessages", + "port_type": "PullPointSubscription", + "description": "This method pulls one or more messages from a PullPoint. The device shall provide the following PullMessages command for all SubscriptionManager endpoints returned by the CreatePullPointSubscription command. This method shall not wait until the requested number of messages is available but return as soon as at least one message is available. The command shall at least support a Timeout of one minute. In case a device supports retrieval of less messages than requested it shall return these without generating a fault.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}PullMessagesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}PullMessages", + "schema": { + "name": "PullMessages", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum time to block until this method returns." + }, + { + "name": "MessageLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Upper limit for the number of messages to return at once. A server implementation may decide to return less messages." + } + ], + "any": { + "namespace": "##other", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}PullMessagesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}PullMessagesResponse", + "schema": { + "name": "PullMessagesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CurrentTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current time of the device for synchronization purposes." + }, + { + "name": "TerminationTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Date time when the PullPoint will be shut down without further pull requests." + }, + { + "name": "NotificationMessage", + "type": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessageHolderType", + "type_name": "NotificationMessageHolderType", + "definition": { + "kind": "complexType", + "name": "NotificationMessageHolderType", + "fields": [ + { + "name": "SubscriptionReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}SubscriptionReference" + }, + { + "name": "Topic", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}Topic" + }, + { + "name": "ProducerReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}ProducerReference" + }, + { + "name": "Message", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessage", + "description": "List of messages. This list shall be empty in case of a timeout." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "PullMessagesFaultResponse", + "message": "{http://www.onvif.org/ver10/events/wsdl}PullMessagesFaultResponse" + } + ], + "binding": "PullPointSubscriptionBinding" + }, + { + "name": "Seek", + "port_type": "PullPointSubscription", + "description": "This method readjusts the pull pointer into the past. A device supporting persistent notification storage shall provide the following Seek command for all SubscriptionManager endpoints returned by the CreatePullPointSubscription command. The optional Reverse argument can be used to reverse the pull direction of the PullMessages command. The UtcTime argument will be matched against the UtcTime attribute on a NotificationMessage.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}SeekRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}Seek", + "schema": { + "name": "Seek", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "UtcTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The date and time to match against stored messages." + }, + { + "name": "Reverse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Reverse the pull direction of PullMessages." + } + ], + "any": { + "namespace": "##other", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}SeekResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}SeekResponse", + "schema": { + "name": "SeekResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PullPointSubscriptionBinding" + }, + { + "name": "SetSynchronizationPoint", + "port_type": "PullPointSubscription", + "description": "Properties inform a client about property creation, changes and deletion in a uniform way. When a client wants to synchronize its properties with the properties of the device, it can request a synchronization point which repeats the current status of all properties to which a client has subscribed. The PropertyOperation of all produced notifications is set to \"Initialized\". The Synchronization Point is requested directly from the SubscriptionManager which was returned in either the SubscriptionResponse or in the CreatePullPointSubscriptionResponse. The property update is transmitted via the notification transportation of the notification interface. This method is mandatory.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}SetSynchronizationPointRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}SetSynchronizationPoint", + "schema": { + "name": "SetSynchronizationPoint", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}SetSynchronizationPointResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}SetSynchronizationPointResponse", + "schema": { + "name": "SetSynchronizationPointResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PullPointSubscriptionBinding" + }, + { + "name": "Unsubscribe", + "port_type": "PullPointSubscription", + "description": "The device shall provide the following Unsubscribe command for all SubscriptionManager endpoints returned by the CreatePullPointSubscription command. This command shall terminate the lifetime of a pull point.", + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsubscribeRequest", + "parts": [ + { + "name": "UnsubscribeRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}Unsubscribe", + "schema": { + "name": "Unsubscribe", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsubscribeResponse", + "parts": [ + { + "name": "UnsubscribeResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}UnsubscribeResponse", + "schema": { + "name": "UnsubscribeResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnableToDestroySubscriptionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnableToDestroySubscriptionFault" + } + ], + "binding": "PullPointSubscriptionBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/events/wsdl/event.json b/docs/generated/wsdl/ver10/events/wsdl/event.json new file mode 100644 index 00000000..6e056ab3 --- /dev/null +++ b/docs/generated/wsdl/ver10/events/wsdl/event.json @@ -0,0 +1,1509 @@ +{ + "source": "ver10/events/wsdl/event.wsdl", + "target_namespace": "http://www.onvif.org/ver10/events/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "EventPortType", + "description": "Returns the capabilities of the event service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/events/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "WSSubscriptionPolicySupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that the WS Subscription policy is supported." + }, + { + "use": "optional", + "name": "WSPausableSubscriptionManagerInterfaceSupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that the WS Pausable Subscription Manager Interface is supported." + }, + { + "use": "optional", + "name": "MaxNotificationProducers", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of supported notification producers as defined by WS-BaseNotification." + }, + { + "use": "optional", + "name": "MaxPullPoints", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum supported number of notification pull points." + }, + { + "use": "optional", + "name": "PersistentNotificationStorage", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication if the device supports persistent notification storage." + }, + { + "use": "optional", + "name": "EventBrokerProtocols", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "A space separated list of supported event broker protocols as defined by the tev:EventBrokerProtocol datatype." + }, + { + "use": "optional", + "name": "MaxEventBrokers", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maxiumum number of event broker configurations that can be added to the device." + }, + { + "use": "optional", + "name": "MetadataOverMQTT", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that metadata streaming over MQTT is supported" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the event service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "EventBinding" + }, + { + "name": "CreatePullPointSubscription", + "port_type": "EventPortType", + "description": "This method returns a PullPointSubscription that can be polled using PullMessages. This message contains the same elements as the SubscriptionRequest of the WS-BaseNotification without the ConsumerReference. If no Filter is specified the pullpoint notifies all occurring events to the client. This method is mandatory.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}CreatePullPointSubscriptionRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}CreatePullPointSubscription", + "schema": { + "name": "CreatePullPointSubscription", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional XPATH expression to select specific topics." + }, + { + "name": "InitialTerminationTime", + "type": "{http://docs.oasis-open.org/wsn/b-2}AbsoluteOrRelativeTimeType", + "type_name": "AbsoluteOrRelativeTimeType", + "definition": { + "kind": "simpleType", + "name": "AbsoluteOrRelativeTimeType", + "member_types": [ + "{http://www.w3.org/2001/XMLSchema}dateTime", + "{http://www.w3.org/2001/XMLSchema}duration" + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": true, + "description": "Initial termination time." + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Refer to Web Services Base Notification 1.3 (WS-BaseNotification)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}CreatePullPointSubscriptionResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}CreatePullPointSubscriptionResponse", + "schema": { + "name": "CreatePullPointSubscriptionResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SubscriptionReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Endpoint reference of the subscription to be used for pulling the messages." + }, + { + "name": "CurrentTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}CurrentTime", + "description": "Current time of the device for synchronization purposes." + }, + { + "name": "TerminationTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}TerminationTime", + "description": "Date time when the PullPoint will be shut down without further pull requests." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "InvalidFilterFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidFilterFault" + }, + { + "name": "TopicExpressionDialectUnknownFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}TopicExpressionDialectUnknownFault" + }, + { + "name": "InvalidTopicExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidTopicExpressionFault" + }, + { + "name": "TopicNotSupportedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}TopicNotSupportedFault" + }, + { + "name": "InvalidProducerPropertiesExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidProducerPropertiesExpressionFault" + }, + { + "name": "InvalidMessageContentExpressionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}InvalidMessageContentExpressionFault" + }, + { + "name": "UnacceptableInitialTerminationTimeFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnacceptableInitialTerminationTimeFault" + }, + { + "name": "UnrecognizedPolicyRequestFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnrecognizedPolicyRequestFault" + }, + { + "name": "UnsupportedPolicyRequestFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsupportedPolicyRequestFault" + }, + { + "name": "NotifyMessageNotSupportedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}NotifyMessageNotSupportedFault" + }, + { + "name": "SubscribeCreationFailedFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}SubscribeCreationFailedFault" + } + ], + "binding": "EventBinding" + }, + { + "name": "GetEventProperties", + "port_type": "EventPortType", + "description": "The WS-BaseNotification specification defines a set of OPTIONAL WS-ResouceProperties. This specification does not require the implementation of the WS-ResourceProperty interface. Instead, the subsequent direct interface shall be implemented by an ONVIF compliant device in order to provide information about the FilterDialects, Schema files and topics supported by the device.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}GetEventPropertiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}GetEventProperties", + "schema": { + "name": "GetEventProperties", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}GetEventPropertiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}GetEventPropertiesResponse", + "schema": { + "name": "GetEventPropertiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TopicNamespaceLocation", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of topic namespaces supported." + }, + { + "name": "FixedTopicSet", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "default": "true", + "ref": "{http://docs.oasis-open.org/wsn/b-2}FixedTopicSet", + "description": "True when topicset is fixed for all times." + }, + { + "name": "TopicSet", + "type": "{http://docs.oasis-open.org/wsn/t-1}TopicSetType", + "type_name": "TopicSetType", + "definition": { + "kind": "complexType", + "name": "TopicSetType", + "base": "{http://docs.oasis-open.org/wsn/t-1}ExtensibleDocumented", + "base_definition": { + "kind": "complexType", + "name": "ExtensibleDocumented", + "fields": [ + { + "name": "documentation", + "type": "{http://docs.oasis-open.org/wsn/t-1}Documentation", + "type_name": "Documentation", + "definition": { + "kind": "complexType", + "name": "Documentation", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/t-1}TopicSet", + "description": "Set of topics supported." + }, + { + "name": "TopicExpressionDialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionDialect", + "description": "Defines the XPath expression syntax supported for matching topic expressions.
\n\t\t\t\t\t\t\tThe following TopicExpressionDialects are mandatory for an ONVIF compliant device :\n\t\t\t\t\t\t\t
    \n\t\t\t\t\t\t\t\t\t\t
  • http://docs.oasis-open.org/wsn/t-1/TopicExpression/Concrete
    • \n\t\t\t\t\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tev/topicExpression/ConcreteSet.
    • \n\t\t\t\t\t\t\t\t\t
" + }, + { + "name": "MessageContentFilterDialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Defines the XPath function set supported for message content filtering.
\n\t\t\t\t\t\tThe following MessageContentFilterDialects should be returned if a device supports the message content filtering:\n\t\t\t\t\t\t\t
    \n\t\t\t\t\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tev/messageContentFilter/ItemFilter.
    • \n\t\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tA device that does not support any MessageContentFilterDialect returns a single empty url." + }, + { + "name": "ProducerPropertiesFilterDialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional ProducerPropertiesDialects. Refer to Web Services Base Notification 1.3 (WS-BaseNotification) for advanced filtering." + }, + { + "name": "MessageContentSchemaLocation", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Message Content Description Language allows referencing\n\t\t\t\t\t\t\tof vendor-specific types. In order to ease the integration of such types into a client application,\n\t\t\t\t\t\t\tthe GetEventPropertiesResponse shall list all URI locations to schema files whose types are\n\t\t\t\t\t\t\tused in the description of notifications, with MessageContentSchemaLocation elements.
\n\t\t\t\t\t\t\tThis list shall at least contain the URI of the ONVIF schema file." + } + ], + "any": { + "namespace": "##other", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "EventBinding" + }, + { + "name": "AddEventBroker", + "port_type": "EventPortType", + "description": "The AddEventBroker command allows an ONVIF client to add an event broker configuration to device to enable ONVIF events to be transferred to an event broker. If an existing event broker configuration already exists with the same Address, the existing configuration shall be modified.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}AddEventBrokerRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}AddEventBroker", + "schema": { + "name": "AddEventBroker", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "EventBroker", + "type": "{http://www.onvif.org/ver10/events/wsdl}EventBrokerConfig", + "type_name": "EventBrokerConfig", + "definition": { + "kind": "complexType", + "name": "EventBrokerConfig", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Event broker address in the format \"scheme://host:port[/resource]\". The supported schemes shall be returned by the EventBrokerProtocols capability. The resource part of the URL is only valid when using websocket. The Address must be unique." + }, + { + "name": "TopicPrefix", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix that will be prepended to all topics before they are published. This is used to make published topics unique for each device. TopicPrefix is not allowed to be empty." + }, + { + "name": "UserName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User name for the event broker." + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Password for the event broker. Password shall not be included when returned with GetEventBrokers." + }, + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional certificate ID in the key store pointing to a client certificate to be used for authenticating the device at the message broker." + }, + { + "name": "PublishFilter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Concrete Topic Expression to select specific event topics to publish." + }, + { + "name": "QoS", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Quality of service level to use when publishing. This defines the guarantee of delivery for a specific message: 0 = At most once, 1 = At least once, 2 = Exactly once." + }, + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Current connection status (see tev:ConnectionStatus for possible values)." + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certification path validation policy used to validate the broker certificate. In case encryption is used but no validation policy is specified, the device shall not validate the broker certificate." + }, + { + "name": "MetadataFilter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Concrete Topic Expression to select specific metadata topics to publish." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}AddEventBrokerResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}AddEventBrokerResponse", + "schema": { + "name": "AddEventBrokerResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "EventBinding" + }, + { + "name": "DeleteEventBroker", + "port_type": "EventPortType", + "description": "The DeleteEventBroker allows an ONVIF client to delete an event broker configuration from an ONVIF device.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}DeleteEventBrokerRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}DeleteEventBroker", + "schema": { + "name": "DeleteEventBroker", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}DeleteEventBrokerResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}DeleteEventBrokerResponse", + "schema": { + "name": "DeleteEventBrokerResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "EventBinding" + }, + { + "name": "GetEventBrokers", + "port_type": "EventPortType", + "description": "The GetEventBrokers command lets a client retrieve event broker configurations from the device.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}GetEventBrokersRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}GetEventBrokers", + "schema": { + "name": "GetEventBrokers", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}GetEventBrokersResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}GetEventBrokersResponse", + "schema": { + "name": "GetEventBrokersResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "EventBroker", + "type": "{http://www.onvif.org/ver10/events/wsdl}EventBrokerConfig", + "type_name": "EventBrokerConfig", + "definition": { + "kind": "complexType", + "name": "EventBrokerConfig", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Event broker address in the format \"scheme://host:port[/resource]\". The supported schemes shall be returned by the EventBrokerProtocols capability. The resource part of the URL is only valid when using websocket. The Address must be unique." + }, + { + "name": "TopicPrefix", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Prefix that will be prepended to all topics before they are published. This is used to make published topics unique for each device. TopicPrefix is not allowed to be empty." + }, + { + "name": "UserName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User name for the event broker." + }, + { + "name": "Password", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Password for the event broker. Password shall not be included when returned with GetEventBrokers." + }, + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}token", + "type_name": "token", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional certificate ID in the key store pointing to a client certificate to be used for authenticating the device at the message broker." + }, + { + "name": "PublishFilter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Concrete Topic Expression to select specific event topics to publish." + }, + { + "name": "QoS", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Quality of service level to use when publishing. This defines the guarantee of delivery for a specific message: 0 = At most once, 1 = At least once, 2 = Exactly once." + }, + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Current connection status (see tev:ConnectionStatus for possible values)." + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The ID of the certification path validation policy used to validate the broker certificate. In case encryption is used but no validation policy is specified, the device shall not validate the broker certificate." + }, + { + "name": "MetadataFilter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Concrete Topic Expression to select specific metadata topics to publish." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "EventBinding" + }, + { + "name": "PullMessages", + "port_type": "PullPointSubscription", + "description": "This method pulls one or more messages from a PullPoint. The device shall provide the following PullMessages command for all SubscriptionManager endpoints returned by the CreatePullPointSubscription command. This method shall not wait until the requested number of messages is available but return as soon as at least one message is available. The command shall at least support a Timeout of one minute. In case a device supports retrieval of less messages than requested it shall return these without generating a fault.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}PullMessagesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}PullMessages", + "schema": { + "name": "PullMessages", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum time to block until this method returns." + }, + { + "name": "MessageLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Upper limit for the number of messages to return at once. A server implementation may decide to return less messages." + } + ], + "any": { + "namespace": "##other", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}PullMessagesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}PullMessagesResponse", + "schema": { + "name": "PullMessagesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "CurrentTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current time of the device for synchronization purposes." + }, + { + "name": "TerminationTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Date time when the PullPoint will be shut down without further pull requests." + }, + { + "name": "NotificationMessage", + "type": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessageHolderType", + "type_name": "NotificationMessageHolderType", + "definition": { + "kind": "complexType", + "name": "NotificationMessageHolderType", + "fields": [ + { + "name": "SubscriptionReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}SubscriptionReference" + }, + { + "name": "Topic", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}Topic" + }, + { + "name": "ProducerReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}ProducerReference" + }, + { + "name": "Message", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessage", + "description": "List of messages. This list shall be empty in case of a timeout." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "PullMessagesFaultResponse", + "message": "{http://www.onvif.org/ver10/events/wsdl}PullMessagesFaultResponse" + } + ], + "binding": "PullPointSubscriptionBinding" + }, + { + "name": "Seek", + "port_type": "PullPointSubscription", + "description": "This method readjusts the pull pointer into the past. A device supporting persistent notification storage shall provide the following Seek command for all SubscriptionManager endpoints returned by the CreatePullPointSubscription command. The optional Reverse argument can be used to reverse the pull direction of the PullMessages command. The UtcTime argument will be matched against the UtcTime attribute on a NotificationMessage.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}SeekRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}Seek", + "schema": { + "name": "Seek", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "UtcTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The date and time to match against stored messages." + }, + { + "name": "Reverse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Reverse the pull direction of PullMessages." + } + ], + "any": { + "namespace": "##other", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}SeekResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}SeekResponse", + "schema": { + "name": "SeekResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PullPointSubscriptionBinding" + }, + { + "name": "SetSynchronizationPoint", + "port_type": "PullPointSubscription", + "description": "Properties inform a client about property creation, changes and deletion in a uniform way. When a client wants to synchronize its properties with the properties of the device, it can request a synchronization point which repeats the current status of all properties to which a client has subscribed. The PropertyOperation of all produced notifications is set to \"Initialized\". The Synchronization Point is requested directly from the SubscriptionManager which was returned in either the SubscriptionResponse or in the CreatePullPointSubscriptionResponse. The property update is transmitted via the notification transportation of the notification interface. This method is mandatory.", + "input": { + "message": "{http://www.onvif.org/ver10/events/wsdl}SetSynchronizationPointRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}SetSynchronizationPoint", + "schema": { + "name": "SetSynchronizationPoint", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/events/wsdl}SetSynchronizationPointResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/events/wsdl}SetSynchronizationPointResponse", + "schema": { + "name": "SetSynchronizationPointResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PullPointSubscriptionBinding" + }, + { + "name": "Unsubscribe", + "port_type": "PullPointSubscription", + "description": "The device shall provide the following Unsubscribe command for all SubscriptionManager endpoints returned by the CreatePullPointSubscription command. This command shall terminate the lifetime of a pull point.", + "input": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsubscribeRequest", + "parts": [ + { + "name": "UnsubscribeRequest", + "element": "{http://docs.oasis-open.org/wsn/b-2}Unsubscribe", + "schema": { + "name": "Unsubscribe", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnsubscribeResponse", + "parts": [ + { + "name": "UnsubscribeResponse", + "element": "{http://docs.oasis-open.org/wsn/b-2}UnsubscribeResponse", + "schema": { + "name": "UnsubscribeResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [ + { + "name": "ResourceUnknownFault", + "message": "{http://docs.oasis-open.org/wsrf/rw-2}ResourceUnknownFault" + }, + { + "name": "UnableToDestroySubscriptionFault", + "message": "{http://docs.oasis-open.org/wsn/bw-2}UnableToDestroySubscriptionFault" + } + ], + "binding": "PullPointSubscriptionBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/federatedsearch.json b/docs/generated/wsdl/ver10/federatedsearch.json new file mode 100644 index 00000000..13ebb0f5 --- /dev/null +++ b/docs/generated/wsdl/ver10/federatedsearch.json @@ -0,0 +1,11192 @@ +{ + "source": "ver10/federatedsearch.wsdl", + "target_namespace": "http://www.onvif.org/ver10/federatedsearch/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "FederatedSearchPort", + "description": "Returns the capabilities of the federated search service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/federatedsearch/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameter", + "element": "{http://www.onvif.org/ver10/federatedsearch/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/federatedsearch/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameter", + "element": "{http://www.onvif.org/ver10/federatedsearch/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/federatedsearch/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "FederatedSearchBinding" + }, + { + "name": "GetServiceFeatures", + "port_type": "FederatedSearchPort", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/federatedsearch/wsdl}GetServiceFeaturesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/federatedsearch/wsdl}GetServiceFeatures", + "schema": { + "name": "GetServiceFeatures", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "InputCapabilities", + "type": "{urn:mpeg:mpqf:schema:2008}MpegQueryType", + "type_name": "MpegQueryType", + "definition": { + "kind": "complexType", + "name": "MpegQueryType", + "fields": [ + { + "name": "Query", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Input", + "type": "{urn:mpeg:mpqf:schema:2008}InputQueryType", + "type_name": "InputQueryType", + "definition": { + "kind": "complexType", + "name": "InputQueryType", + "fields": [ + { + "name": "QFDeclaration", + "type": "{urn:mpeg:mpqf:schema:2008}QFDeclarationType", + "type_name": "QFDeclarationType", + "definition": { + "kind": "complexType", + "name": "QFDeclarationType", + "fields": [ + { + "name": "DeclaredField", + "type": "{urn:mpeg:mpqf:schema:2008}DeclaredFieldType", + "type_name": "DeclaredFieldType", + "definition": { + "kind": "complexType", + "name": "DeclaredFieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + }, + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Resource", + "type": "{urn:mpeg:mpqf:schema:2008}ResourceType", + "type_name": "ResourceType", + "definition": { + "kind": "complexType", + "name": "ResourceType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "resourceID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Prefix", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "OutputDescription", + "type": "{urn:mpeg:mpqf:schema:2008}OutputDescriptionType", + "type_name": "OutputDescriptionType", + "definition": { + "kind": "complexType", + "name": "OutputDescriptionType", + "fields": [ + { + "name": "ReqField", + "type": "{urn:mpeg:mpqf:schema:2008}FieldType", + "type_name": "FieldType", + "definition": { + "kind": "complexType", + "name": "FieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fragmentResultName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "fieldREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "resultMode", + "default": "structured" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "ReqAggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF", + "type_name": "IDREF", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "ReqSemanticField", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "GroupBy", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "GroupByField", + "type": "{urn:mpeg:mpqf:schema:2008}FieldType", + "type_name": "FieldType", + "definition": { + "kind": "complexType", + "name": "FieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fragmentResultName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "fieldREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "resultMode", + "default": "structured" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Aggregate", + "type": "{urn:mpeg:mpqf:schema:2008}AggregateExpressionType", + "type_name": "AggregateExpressionType", + "definition": { + "kind": "complexType", + "name": "AggregateExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SortBy", + "type": "{urn:mpeg:mpqf:schema:2008}AbstractSortByType", + "type_name": "AbstractSortByType", + "definition": { + "kind": "complexType", + "name": "AbstractSortByType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "order" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "maxPageEntries", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "maxItemCount", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "freeTextUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "thumbnailUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "mediaResourceUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "outputNameSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "distinct", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "QueryCondition", + "type": "{urn:mpeg:mpqf:schema:2008}QueryConditionType", + "type_name": "QueryConditionType", + "definition": { + "kind": "complexType", + "name": "QueryConditionType", + "fields": [ + { + "name": "EvaluationPath", + "type": "{urn:mpeg:mpqf:schema:2008}xPathType", + "type_name": "xPathType", + "definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TargetMediaType", + "type": "{urn:mpeg:mpqf:schema:2008}mimeType", + "type_name": "mimeType", + "definition": { + "kind": "simpleType", + "name": "mimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "([Xx]\\-)?[!#$%'*+.0-9A-Z\\^-~]+/([Xx]\\- )?[!#$%'*+.0-9A-Z\\^-~\\-]+", + "whiteSpace": "collapse" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Join", + "type": "{urn:mpeg:mpqf:schema:2008}JoinType", + "type_name": "JoinType", + "definition": { + "kind": "complexType", + "name": "JoinType", + "fields": [ + { + "name": "From", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "EvaluationPath", + "type": "{urn:mpeg:mpqf:schema:2008}xPathType", + "type_name": "xPathType", + "definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TargetMediaType", + "type": "{urn:mpeg:mpqf:schema:2008}mimeType", + "type_name": "mimeType", + "definition": { + "kind": "simpleType", + "name": "mimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "([Xx]\\-)?[!#$%'*+.0-9A-Z\\^-~]+/([Xx]\\- )?[!#$%'*+.0-9A-Z\\^-~\\-]+", + "whiteSpace": "collapse" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Condition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 1, + "max_occurs": 2, + "nillable": false + }, + { + "name": "JoinCondition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Condition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ServiceSelection", + "type": "{urn:mpeg:mpqf:schema:2008}ServiceSelectionType", + "type_name": "ServiceSelectionType", + "definition": { + "kind": "complexType", + "name": "ServiceSelectionType", + "fields": [ + { + "name": "ServiceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "previousAnswerID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "immediateResponse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "true" + }, + { + "use": "optional", + "name": "streamingResponse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false" + }, + { + "use": "optional", + "name": "timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "FetchResult", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Output", + "type": "{urn:mpeg:mpqf:schema:2008}OutputQueryType", + "type_name": "OutputQueryType", + "definition": { + "kind": "complexType", + "name": "OutputQueryType", + "fields": [ + { + "name": "GlobalComment", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ResultItem", + "type": "{urn:mpeg:mpqf:schema:2008}ResultItemType", + "type_name": "ResultItemType", + "definition": { + "kind": "complexType", + "name": "ResultItemType", + "base": "{urn:mpeg:mpqf:schema:2008}ResultItemBaseType", + "base_definition": { + "kind": "complexType", + "name": "ResultItemBaseType", + "fields": [] + }, + "fields": [ + { + "name": "Comment", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "TextResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "Thumbnail", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "MediaResource", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "Description", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "AggregationResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "FragmentResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "recordNumber", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "rank", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "confidence", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + }, + { + "use": "optional", + "name": "originID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SystemMessage", + "type": "{urn:mpeg:mpqf:schema:2008}SystemMessageType", + "type_name": "SystemMessageType", + "definition": { + "kind": "complexType", + "name": "SystemMessageType", + "fields": [ + { + "name": "Status", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Warning", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Exception", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "currPage", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "default": "1" + }, + { + "use": "optional", + "name": "totalPages", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "default": "1" + }, + { + "use": "optional", + "name": "expirationDate", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Management", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Input", + "type": "{urn:mpeg:mpqf:schema:2008}InputManagementType", + "type_name": "InputManagementType", + "definition": { + "kind": "complexType", + "name": "InputManagementType", + "fields": [ + { + "name": "DesiredCapability", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityType", + "type_name": "CapabilityType", + "definition": { + "kind": "complexType", + "name": "CapabilityType", + "fields": [ + { + "name": "SupportedQFProfile", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExampleMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedResultMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedQueryTypes", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExpressions", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "UsageConditions", + "definition": { + "kind": "complexType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ServiceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Output", + "type": "{urn:mpeg:mpqf:schema:2008}OutputManagementType", + "type_name": "OutputManagementType", + "definition": { + "kind": "complexType", + "name": "OutputManagementType", + "fields": [ + { + "name": "AvailableCapability", + "type": "{urn:mpeg:mpqf:schema:2008}AvailableCapabilityType", + "type_name": "AvailableCapabilityType", + "definition": { + "kind": "complexType", + "name": "AvailableCapabilityType", + "base": "{urn:mpeg:mpqf:schema:2008}CapabilityType", + "base_definition": { + "kind": "complexType", + "name": "CapabilityType", + "fields": [ + { + "name": "SupportedQFProfile", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExampleMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedResultMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedQueryTypes", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExpressions", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "UsageConditions", + "definition": { + "kind": "complexType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "required", + "name": "serviceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SystemMessage", + "type": "{urn:mpeg:mpqf:schema:2008}SystemMessageType", + "type_name": "SystemMessageType", + "definition": { + "kind": "complexType", + "name": "SystemMessageType", + "fields": [ + { + "name": "Status", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Warning", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Exception", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "required", + "name": "mpqfID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains descriptions of desired services\n\t\t\t\t\t\t\t\t\tcapabilities and may contain the ID for a particular service to\n\t\t\t\t\t\t\t\t\tbe addressed." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/federatedsearch/wsdl}GetServiceFeaturesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/federatedsearch/wsdl}GetServiceFeaturesResponse", + "schema": { + "name": "GetServiceFeaturesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OutputCapabilities", + "type": "{urn:mpeg:mpqf:schema:2008}MpegQueryType", + "type_name": "MpegQueryType", + "definition": { + "kind": "complexType", + "name": "MpegQueryType", + "fields": [ + { + "name": "Query", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Input", + "type": "{urn:mpeg:mpqf:schema:2008}InputQueryType", + "type_name": "InputQueryType", + "definition": { + "kind": "complexType", + "name": "InputQueryType", + "fields": [ + { + "name": "QFDeclaration", + "type": "{urn:mpeg:mpqf:schema:2008}QFDeclarationType", + "type_name": "QFDeclarationType", + "definition": { + "kind": "complexType", + "name": "QFDeclarationType", + "fields": [ + { + "name": "DeclaredField", + "type": "{urn:mpeg:mpqf:schema:2008}DeclaredFieldType", + "type_name": "DeclaredFieldType", + "definition": { + "kind": "complexType", + "name": "DeclaredFieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + }, + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Resource", + "type": "{urn:mpeg:mpqf:schema:2008}ResourceType", + "type_name": "ResourceType", + "definition": { + "kind": "complexType", + "name": "ResourceType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "resourceID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Prefix", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "OutputDescription", + "type": "{urn:mpeg:mpqf:schema:2008}OutputDescriptionType", + "type_name": "OutputDescriptionType", + "definition": { + "kind": "complexType", + "name": "OutputDescriptionType", + "fields": [ + { + "name": "ReqField", + "type": "{urn:mpeg:mpqf:schema:2008}FieldType", + "type_name": "FieldType", + "definition": { + "kind": "complexType", + "name": "FieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fragmentResultName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "fieldREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "resultMode", + "default": "structured" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "ReqAggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF", + "type_name": "IDREF", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "ReqSemanticField", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "GroupBy", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "GroupByField", + "type": "{urn:mpeg:mpqf:schema:2008}FieldType", + "type_name": "FieldType", + "definition": { + "kind": "complexType", + "name": "FieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fragmentResultName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "fieldREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "resultMode", + "default": "structured" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Aggregate", + "type": "{urn:mpeg:mpqf:schema:2008}AggregateExpressionType", + "type_name": "AggregateExpressionType", + "definition": { + "kind": "complexType", + "name": "AggregateExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SortBy", + "type": "{urn:mpeg:mpqf:schema:2008}AbstractSortByType", + "type_name": "AbstractSortByType", + "definition": { + "kind": "complexType", + "name": "AbstractSortByType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "order" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "maxPageEntries", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "maxItemCount", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "freeTextUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "thumbnailUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "mediaResourceUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "outputNameSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "distinct", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "QueryCondition", + "type": "{urn:mpeg:mpqf:schema:2008}QueryConditionType", + "type_name": "QueryConditionType", + "definition": { + "kind": "complexType", + "name": "QueryConditionType", + "fields": [ + { + "name": "EvaluationPath", + "type": "{urn:mpeg:mpqf:schema:2008}xPathType", + "type_name": "xPathType", + "definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TargetMediaType", + "type": "{urn:mpeg:mpqf:schema:2008}mimeType", + "type_name": "mimeType", + "definition": { + "kind": "simpleType", + "name": "mimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "([Xx]\\-)?[!#$%'*+.0-9A-Z\\^-~]+/([Xx]\\- )?[!#$%'*+.0-9A-Z\\^-~\\-]+", + "whiteSpace": "collapse" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Join", + "type": "{urn:mpeg:mpqf:schema:2008}JoinType", + "type_name": "JoinType", + "definition": { + "kind": "complexType", + "name": "JoinType", + "fields": [ + { + "name": "From", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "EvaluationPath", + "type": "{urn:mpeg:mpqf:schema:2008}xPathType", + "type_name": "xPathType", + "definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TargetMediaType", + "type": "{urn:mpeg:mpqf:schema:2008}mimeType", + "type_name": "mimeType", + "definition": { + "kind": "simpleType", + "name": "mimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "([Xx]\\-)?[!#$%'*+.0-9A-Z\\^-~]+/([Xx]\\- )?[!#$%'*+.0-9A-Z\\^-~\\-]+", + "whiteSpace": "collapse" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Condition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 1, + "max_occurs": 2, + "nillable": false + }, + { + "name": "JoinCondition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Condition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ServiceSelection", + "type": "{urn:mpeg:mpqf:schema:2008}ServiceSelectionType", + "type_name": "ServiceSelectionType", + "definition": { + "kind": "complexType", + "name": "ServiceSelectionType", + "fields": [ + { + "name": "ServiceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "previousAnswerID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "immediateResponse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "true" + }, + { + "use": "optional", + "name": "streamingResponse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false" + }, + { + "use": "optional", + "name": "timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "FetchResult", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Output", + "type": "{urn:mpeg:mpqf:schema:2008}OutputQueryType", + "type_name": "OutputQueryType", + "definition": { + "kind": "complexType", + "name": "OutputQueryType", + "fields": [ + { + "name": "GlobalComment", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ResultItem", + "type": "{urn:mpeg:mpqf:schema:2008}ResultItemType", + "type_name": "ResultItemType", + "definition": { + "kind": "complexType", + "name": "ResultItemType", + "base": "{urn:mpeg:mpqf:schema:2008}ResultItemBaseType", + "base_definition": { + "kind": "complexType", + "name": "ResultItemBaseType", + "fields": [] + }, + "fields": [ + { + "name": "Comment", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "TextResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "Thumbnail", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "MediaResource", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "Description", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "AggregationResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "FragmentResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "recordNumber", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "rank", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "confidence", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + }, + { + "use": "optional", + "name": "originID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SystemMessage", + "type": "{urn:mpeg:mpqf:schema:2008}SystemMessageType", + "type_name": "SystemMessageType", + "definition": { + "kind": "complexType", + "name": "SystemMessageType", + "fields": [ + { + "name": "Status", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Warning", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Exception", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "currPage", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "default": "1" + }, + { + "use": "optional", + "name": "totalPages", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "default": "1" + }, + { + "use": "optional", + "name": "expirationDate", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Management", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Input", + "type": "{urn:mpeg:mpqf:schema:2008}InputManagementType", + "type_name": "InputManagementType", + "definition": { + "kind": "complexType", + "name": "InputManagementType", + "fields": [ + { + "name": "DesiredCapability", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityType", + "type_name": "CapabilityType", + "definition": { + "kind": "complexType", + "name": "CapabilityType", + "fields": [ + { + "name": "SupportedQFProfile", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExampleMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedResultMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedQueryTypes", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExpressions", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "UsageConditions", + "definition": { + "kind": "complexType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ServiceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Output", + "type": "{urn:mpeg:mpqf:schema:2008}OutputManagementType", + "type_name": "OutputManagementType", + "definition": { + "kind": "complexType", + "name": "OutputManagementType", + "fields": [ + { + "name": "AvailableCapability", + "type": "{urn:mpeg:mpqf:schema:2008}AvailableCapabilityType", + "type_name": "AvailableCapabilityType", + "definition": { + "kind": "complexType", + "name": "AvailableCapabilityType", + "base": "{urn:mpeg:mpqf:schema:2008}CapabilityType", + "base_definition": { + "kind": "complexType", + "name": "CapabilityType", + "fields": [ + { + "name": "SupportedQFProfile", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExampleMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedResultMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedQueryTypes", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExpressions", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "UsageConditions", + "definition": { + "kind": "complexType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "required", + "name": "serviceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SystemMessage", + "type": "{urn:mpeg:mpqf:schema:2008}SystemMessageType", + "type_name": "SystemMessageType", + "definition": { + "kind": "complexType", + "name": "SystemMessageType", + "fields": [ + { + "name": "Status", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Warning", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Exception", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "required", + "name": "mpqfID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a list of available service capability\n\t\t\t\t\t\t\t\t\tdescriptions or a system message in case of an error. If no\n\t\t\t\t\t\t\t\t\tservice is available or matches the given capabilities, then an\n\t\t\t\t\t\t\t\t\tempty Output element is returned." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "FederatedSearchBinding" + }, + { + "name": "Search", + "port_type": "FederatedSearchPort", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/federatedsearch/wsdl}SearchRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/federatedsearch/wsdl}Search", + "schema": { + "name": "Search", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "InputQuery", + "type": "{urn:mpeg:mpqf:schema:2008}MpegQueryType", + "type_name": "MpegQueryType", + "definition": { + "kind": "complexType", + "name": "MpegQueryType", + "fields": [ + { + "name": "Query", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Input", + "type": "{urn:mpeg:mpqf:schema:2008}InputQueryType", + "type_name": "InputQueryType", + "definition": { + "kind": "complexType", + "name": "InputQueryType", + "fields": [ + { + "name": "QFDeclaration", + "type": "{urn:mpeg:mpqf:schema:2008}QFDeclarationType", + "type_name": "QFDeclarationType", + "definition": { + "kind": "complexType", + "name": "QFDeclarationType", + "fields": [ + { + "name": "DeclaredField", + "type": "{urn:mpeg:mpqf:schema:2008}DeclaredFieldType", + "type_name": "DeclaredFieldType", + "definition": { + "kind": "complexType", + "name": "DeclaredFieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + }, + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Resource", + "type": "{urn:mpeg:mpqf:schema:2008}ResourceType", + "type_name": "ResourceType", + "definition": { + "kind": "complexType", + "name": "ResourceType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "resourceID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Prefix", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "OutputDescription", + "type": "{urn:mpeg:mpqf:schema:2008}OutputDescriptionType", + "type_name": "OutputDescriptionType", + "definition": { + "kind": "complexType", + "name": "OutputDescriptionType", + "fields": [ + { + "name": "ReqField", + "type": "{urn:mpeg:mpqf:schema:2008}FieldType", + "type_name": "FieldType", + "definition": { + "kind": "complexType", + "name": "FieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fragmentResultName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "fieldREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "resultMode", + "default": "structured" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "ReqAggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF", + "type_name": "IDREF", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "ReqSemanticField", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "GroupBy", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "GroupByField", + "type": "{urn:mpeg:mpqf:schema:2008}FieldType", + "type_name": "FieldType", + "definition": { + "kind": "complexType", + "name": "FieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fragmentResultName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "fieldREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "resultMode", + "default": "structured" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Aggregate", + "type": "{urn:mpeg:mpqf:schema:2008}AggregateExpressionType", + "type_name": "AggregateExpressionType", + "definition": { + "kind": "complexType", + "name": "AggregateExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SortBy", + "type": "{urn:mpeg:mpqf:schema:2008}AbstractSortByType", + "type_name": "AbstractSortByType", + "definition": { + "kind": "complexType", + "name": "AbstractSortByType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "order" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "maxPageEntries", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "maxItemCount", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "freeTextUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "thumbnailUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "mediaResourceUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "outputNameSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "distinct", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "QueryCondition", + "type": "{urn:mpeg:mpqf:schema:2008}QueryConditionType", + "type_name": "QueryConditionType", + "definition": { + "kind": "complexType", + "name": "QueryConditionType", + "fields": [ + { + "name": "EvaluationPath", + "type": "{urn:mpeg:mpqf:schema:2008}xPathType", + "type_name": "xPathType", + "definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TargetMediaType", + "type": "{urn:mpeg:mpqf:schema:2008}mimeType", + "type_name": "mimeType", + "definition": { + "kind": "simpleType", + "name": "mimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "([Xx]\\-)?[!#$%'*+.0-9A-Z\\^-~]+/([Xx]\\- )?[!#$%'*+.0-9A-Z\\^-~\\-]+", + "whiteSpace": "collapse" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Join", + "type": "{urn:mpeg:mpqf:schema:2008}JoinType", + "type_name": "JoinType", + "definition": { + "kind": "complexType", + "name": "JoinType", + "fields": [ + { + "name": "From", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "EvaluationPath", + "type": "{urn:mpeg:mpqf:schema:2008}xPathType", + "type_name": "xPathType", + "definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TargetMediaType", + "type": "{urn:mpeg:mpqf:schema:2008}mimeType", + "type_name": "mimeType", + "definition": { + "kind": "simpleType", + "name": "mimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "([Xx]\\-)?[!#$%'*+.0-9A-Z\\^-~]+/([Xx]\\- )?[!#$%'*+.0-9A-Z\\^-~\\-]+", + "whiteSpace": "collapse" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Condition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 1, + "max_occurs": 2, + "nillable": false + }, + { + "name": "JoinCondition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Condition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ServiceSelection", + "type": "{urn:mpeg:mpqf:schema:2008}ServiceSelectionType", + "type_name": "ServiceSelectionType", + "definition": { + "kind": "complexType", + "name": "ServiceSelectionType", + "fields": [ + { + "name": "ServiceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "previousAnswerID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "immediateResponse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "true" + }, + { + "use": "optional", + "name": "streamingResponse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false" + }, + { + "use": "optional", + "name": "timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "FetchResult", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Output", + "type": "{urn:mpeg:mpqf:schema:2008}OutputQueryType", + "type_name": "OutputQueryType", + "definition": { + "kind": "complexType", + "name": "OutputQueryType", + "fields": [ + { + "name": "GlobalComment", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ResultItem", + "type": "{urn:mpeg:mpqf:schema:2008}ResultItemType", + "type_name": "ResultItemType", + "definition": { + "kind": "complexType", + "name": "ResultItemType", + "base": "{urn:mpeg:mpqf:schema:2008}ResultItemBaseType", + "base_definition": { + "kind": "complexType", + "name": "ResultItemBaseType", + "fields": [] + }, + "fields": [ + { + "name": "Comment", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "TextResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "Thumbnail", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "MediaResource", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "Description", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "AggregationResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "FragmentResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "recordNumber", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "rank", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "confidence", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + }, + { + "use": "optional", + "name": "originID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SystemMessage", + "type": "{urn:mpeg:mpqf:schema:2008}SystemMessageType", + "type_name": "SystemMessageType", + "definition": { + "kind": "complexType", + "name": "SystemMessageType", + "fields": [ + { + "name": "Status", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Warning", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Exception", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "currPage", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "default": "1" + }, + { + "use": "optional", + "name": "totalPages", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "default": "1" + }, + { + "use": "optional", + "name": "expirationDate", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Management", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Input", + "type": "{urn:mpeg:mpqf:schema:2008}InputManagementType", + "type_name": "InputManagementType", + "definition": { + "kind": "complexType", + "name": "InputManagementType", + "fields": [ + { + "name": "DesiredCapability", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityType", + "type_name": "CapabilityType", + "definition": { + "kind": "complexType", + "name": "CapabilityType", + "fields": [ + { + "name": "SupportedQFProfile", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExampleMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedResultMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedQueryTypes", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExpressions", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "UsageConditions", + "definition": { + "kind": "complexType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ServiceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Output", + "type": "{urn:mpeg:mpqf:schema:2008}OutputManagementType", + "type_name": "OutputManagementType", + "definition": { + "kind": "complexType", + "name": "OutputManagementType", + "fields": [ + { + "name": "AvailableCapability", + "type": "{urn:mpeg:mpqf:schema:2008}AvailableCapabilityType", + "type_name": "AvailableCapabilityType", + "definition": { + "kind": "complexType", + "name": "AvailableCapabilityType", + "base": "{urn:mpeg:mpqf:schema:2008}CapabilityType", + "base_definition": { + "kind": "complexType", + "name": "CapabilityType", + "fields": [ + { + "name": "SupportedQFProfile", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExampleMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedResultMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedQueryTypes", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExpressions", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "UsageConditions", + "definition": { + "kind": "complexType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "required", + "name": "serviceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SystemMessage", + "type": "{urn:mpeg:mpqf:schema:2008}SystemMessageType", + "type_name": "SystemMessageType", + "definition": { + "kind": "complexType", + "name": "SystemMessageType", + "fields": [ + { + "name": "Status", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Warning", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Exception", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "required", + "name": "mpqfID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Container for describing a query request\n\t\t\t\t\t\t\t\t\tcontaining a set of conditions and/or the specification of the\n\t\t\t\t\t\t\t\t\tstructure and content of the output query format and a\n\t\t\t\t\t\t\t\t\tdeclaration part." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/federatedsearch/wsdl}SearchResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/federatedsearch/wsdl}SearchResponse", + "schema": { + "name": "SearchResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OutputQuery", + "type": "{urn:mpeg:mpqf:schema:2008}MpegQueryType", + "type_name": "MpegQueryType", + "definition": { + "kind": "complexType", + "name": "MpegQueryType", + "fields": [ + { + "name": "Query", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Input", + "type": "{urn:mpeg:mpqf:schema:2008}InputQueryType", + "type_name": "InputQueryType", + "definition": { + "kind": "complexType", + "name": "InputQueryType", + "fields": [ + { + "name": "QFDeclaration", + "type": "{urn:mpeg:mpqf:schema:2008}QFDeclarationType", + "type_name": "QFDeclarationType", + "definition": { + "kind": "complexType", + "name": "QFDeclarationType", + "fields": [ + { + "name": "DeclaredField", + "type": "{urn:mpeg:mpqf:schema:2008}DeclaredFieldType", + "type_name": "DeclaredFieldType", + "definition": { + "kind": "complexType", + "name": "DeclaredFieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + }, + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Resource", + "type": "{urn:mpeg:mpqf:schema:2008}ResourceType", + "type_name": "ResourceType", + "definition": { + "kind": "complexType", + "name": "ResourceType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "resourceID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Prefix", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "OutputDescription", + "type": "{urn:mpeg:mpqf:schema:2008}OutputDescriptionType", + "type_name": "OutputDescriptionType", + "definition": { + "kind": "complexType", + "name": "OutputDescriptionType", + "fields": [ + { + "name": "ReqField", + "type": "{urn:mpeg:mpqf:schema:2008}FieldType", + "type_name": "FieldType", + "definition": { + "kind": "complexType", + "name": "FieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fragmentResultName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "fieldREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "resultMode", + "default": "structured" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "ReqAggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF", + "type_name": "IDREF", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "ReqSemanticField", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "GroupBy", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "GroupByField", + "type": "{urn:mpeg:mpqf:schema:2008}FieldType", + "type_name": "FieldType", + "definition": { + "kind": "complexType", + "name": "FieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fragmentResultName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "fieldREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "resultMode", + "default": "structured" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Aggregate", + "type": "{urn:mpeg:mpqf:schema:2008}AggregateExpressionType", + "type_name": "AggregateExpressionType", + "definition": { + "kind": "complexType", + "name": "AggregateExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SortBy", + "type": "{urn:mpeg:mpqf:schema:2008}AbstractSortByType", + "type_name": "AbstractSortByType", + "definition": { + "kind": "complexType", + "name": "AbstractSortByType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "order" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "maxPageEntries", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "maxItemCount", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "freeTextUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "thumbnailUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "mediaResourceUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "outputNameSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "distinct", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "QueryCondition", + "type": "{urn:mpeg:mpqf:schema:2008}QueryConditionType", + "type_name": "QueryConditionType", + "definition": { + "kind": "complexType", + "name": "QueryConditionType", + "fields": [ + { + "name": "EvaluationPath", + "type": "{urn:mpeg:mpqf:schema:2008}xPathType", + "type_name": "xPathType", + "definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TargetMediaType", + "type": "{urn:mpeg:mpqf:schema:2008}mimeType", + "type_name": "mimeType", + "definition": { + "kind": "simpleType", + "name": "mimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "([Xx]\\-)?[!#$%'*+.0-9A-Z\\^-~]+/([Xx]\\- )?[!#$%'*+.0-9A-Z\\^-~\\-]+", + "whiteSpace": "collapse" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Join", + "type": "{urn:mpeg:mpqf:schema:2008}JoinType", + "type_name": "JoinType", + "definition": { + "kind": "complexType", + "name": "JoinType", + "fields": [ + { + "name": "From", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "EvaluationPath", + "type": "{urn:mpeg:mpqf:schema:2008}xPathType", + "type_name": "xPathType", + "definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TargetMediaType", + "type": "{urn:mpeg:mpqf:schema:2008}mimeType", + "type_name": "mimeType", + "definition": { + "kind": "simpleType", + "name": "mimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "([Xx]\\-)?[!#$%'*+.0-9A-Z\\^-~]+/([Xx]\\- )?[!#$%'*+.0-9A-Z\\^-~\\-]+", + "whiteSpace": "collapse" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Condition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 1, + "max_occurs": 2, + "nillable": false + }, + { + "name": "JoinCondition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Condition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ServiceSelection", + "type": "{urn:mpeg:mpqf:schema:2008}ServiceSelectionType", + "type_name": "ServiceSelectionType", + "definition": { + "kind": "complexType", + "name": "ServiceSelectionType", + "fields": [ + { + "name": "ServiceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "previousAnswerID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "immediateResponse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "true" + }, + { + "use": "optional", + "name": "streamingResponse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false" + }, + { + "use": "optional", + "name": "timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "FetchResult", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Output", + "type": "{urn:mpeg:mpqf:schema:2008}OutputQueryType", + "type_name": "OutputQueryType", + "definition": { + "kind": "complexType", + "name": "OutputQueryType", + "fields": [ + { + "name": "GlobalComment", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ResultItem", + "type": "{urn:mpeg:mpqf:schema:2008}ResultItemType", + "type_name": "ResultItemType", + "definition": { + "kind": "complexType", + "name": "ResultItemType", + "base": "{urn:mpeg:mpqf:schema:2008}ResultItemBaseType", + "base_definition": { + "kind": "complexType", + "name": "ResultItemBaseType", + "fields": [] + }, + "fields": [ + { + "name": "Comment", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "TextResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "Thumbnail", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "MediaResource", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "Description", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "AggregationResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "FragmentResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "recordNumber", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "rank", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "confidence", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + }, + { + "use": "optional", + "name": "originID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SystemMessage", + "type": "{urn:mpeg:mpqf:schema:2008}SystemMessageType", + "type_name": "SystemMessageType", + "definition": { + "kind": "complexType", + "name": "SystemMessageType", + "fields": [ + { + "name": "Status", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Warning", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Exception", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "currPage", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "default": "1" + }, + { + "use": "optional", + "name": "totalPages", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "default": "1" + }, + { + "use": "optional", + "name": "expirationDate", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Management", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Input", + "type": "{urn:mpeg:mpqf:schema:2008}InputManagementType", + "type_name": "InputManagementType", + "definition": { + "kind": "complexType", + "name": "InputManagementType", + "fields": [ + { + "name": "DesiredCapability", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityType", + "type_name": "CapabilityType", + "definition": { + "kind": "complexType", + "name": "CapabilityType", + "fields": [ + { + "name": "SupportedQFProfile", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExampleMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedResultMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedQueryTypes", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExpressions", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "UsageConditions", + "definition": { + "kind": "complexType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ServiceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Output", + "type": "{urn:mpeg:mpqf:schema:2008}OutputManagementType", + "type_name": "OutputManagementType", + "definition": { + "kind": "complexType", + "name": "OutputManagementType", + "fields": [ + { + "name": "AvailableCapability", + "type": "{urn:mpeg:mpqf:schema:2008}AvailableCapabilityType", + "type_name": "AvailableCapabilityType", + "definition": { + "kind": "complexType", + "name": "AvailableCapabilityType", + "base": "{urn:mpeg:mpqf:schema:2008}CapabilityType", + "base_definition": { + "kind": "complexType", + "name": "CapabilityType", + "fields": [ + { + "name": "SupportedQFProfile", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExampleMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedResultMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedQueryTypes", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExpressions", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "UsageConditions", + "definition": { + "kind": "complexType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "required", + "name": "serviceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SystemMessage", + "type": "{urn:mpeg:mpqf:schema:2008}SystemMessageType", + "type_name": "SystemMessageType", + "definition": { + "kind": "complexType", + "name": "SystemMessageType", + "fields": [ + { + "name": "Status", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Warning", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Exception", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "required", + "name": "mpqfID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Container for all the results from a responder to\n\t\t\t\t\t\t\t\t\ta requester. It may contain in addition messages such as error\n\t\t\t\t\t\t\t\t\tand exception." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "FederatedSearchBinding" + }, + { + "name": "GetSearchResults", + "port_type": "FederatedSearchPort", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/federatedsearch/wsdl}GetSearchResultsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/federatedsearch/wsdl}GetSearchResults", + "schema": { + "name": "GetSearchResults", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Results", + "type": "{urn:mpeg:mpqf:schema:2008}MpegQueryType", + "type_name": "MpegQueryType", + "definition": { + "kind": "complexType", + "name": "MpegQueryType", + "fields": [ + { + "name": "Query", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Input", + "type": "{urn:mpeg:mpqf:schema:2008}InputQueryType", + "type_name": "InputQueryType", + "definition": { + "kind": "complexType", + "name": "InputQueryType", + "fields": [ + { + "name": "QFDeclaration", + "type": "{urn:mpeg:mpqf:schema:2008}QFDeclarationType", + "type_name": "QFDeclarationType", + "definition": { + "kind": "complexType", + "name": "QFDeclarationType", + "fields": [ + { + "name": "DeclaredField", + "type": "{urn:mpeg:mpqf:schema:2008}DeclaredFieldType", + "type_name": "DeclaredFieldType", + "definition": { + "kind": "complexType", + "name": "DeclaredFieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + }, + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Resource", + "type": "{urn:mpeg:mpqf:schema:2008}ResourceType", + "type_name": "ResourceType", + "definition": { + "kind": "complexType", + "name": "ResourceType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "resourceID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Prefix", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "OutputDescription", + "type": "{urn:mpeg:mpqf:schema:2008}OutputDescriptionType", + "type_name": "OutputDescriptionType", + "definition": { + "kind": "complexType", + "name": "OutputDescriptionType", + "fields": [ + { + "name": "ReqField", + "type": "{urn:mpeg:mpqf:schema:2008}FieldType", + "type_name": "FieldType", + "definition": { + "kind": "complexType", + "name": "FieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fragmentResultName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "fieldREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "resultMode", + "default": "structured" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "ReqAggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF", + "type_name": "IDREF", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "ReqSemanticField", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "GroupBy", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "GroupByField", + "type": "{urn:mpeg:mpqf:schema:2008}FieldType", + "type_name": "FieldType", + "definition": { + "kind": "complexType", + "name": "FieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fragmentResultName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "fieldREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "resultMode", + "default": "structured" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Aggregate", + "type": "{urn:mpeg:mpqf:schema:2008}AggregateExpressionType", + "type_name": "AggregateExpressionType", + "definition": { + "kind": "complexType", + "name": "AggregateExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SortBy", + "type": "{urn:mpeg:mpqf:schema:2008}AbstractSortByType", + "type_name": "AbstractSortByType", + "definition": { + "kind": "complexType", + "name": "AbstractSortByType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "order" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "maxPageEntries", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "maxItemCount", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "freeTextUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "thumbnailUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "mediaResourceUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "outputNameSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "distinct", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "QueryCondition", + "type": "{urn:mpeg:mpqf:schema:2008}QueryConditionType", + "type_name": "QueryConditionType", + "definition": { + "kind": "complexType", + "name": "QueryConditionType", + "fields": [ + { + "name": "EvaluationPath", + "type": "{urn:mpeg:mpqf:schema:2008}xPathType", + "type_name": "xPathType", + "definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TargetMediaType", + "type": "{urn:mpeg:mpqf:schema:2008}mimeType", + "type_name": "mimeType", + "definition": { + "kind": "simpleType", + "name": "mimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "([Xx]\\-)?[!#$%'*+.0-9A-Z\\^-~]+/([Xx]\\- )?[!#$%'*+.0-9A-Z\\^-~\\-]+", + "whiteSpace": "collapse" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Join", + "type": "{urn:mpeg:mpqf:schema:2008}JoinType", + "type_name": "JoinType", + "definition": { + "kind": "complexType", + "name": "JoinType", + "fields": [ + { + "name": "From", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "EvaluationPath", + "type": "{urn:mpeg:mpqf:schema:2008}xPathType", + "type_name": "xPathType", + "definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TargetMediaType", + "type": "{urn:mpeg:mpqf:schema:2008}mimeType", + "type_name": "mimeType", + "definition": { + "kind": "simpleType", + "name": "mimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "([Xx]\\-)?[!#$%'*+.0-9A-Z\\^-~]+/([Xx]\\- )?[!#$%'*+.0-9A-Z\\^-~\\-]+", + "whiteSpace": "collapse" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Condition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 1, + "max_occurs": 2, + "nillable": false + }, + { + "name": "JoinCondition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Condition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ServiceSelection", + "type": "{urn:mpeg:mpqf:schema:2008}ServiceSelectionType", + "type_name": "ServiceSelectionType", + "definition": { + "kind": "complexType", + "name": "ServiceSelectionType", + "fields": [ + { + "name": "ServiceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "previousAnswerID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "immediateResponse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "true" + }, + { + "use": "optional", + "name": "streamingResponse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false" + }, + { + "use": "optional", + "name": "timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "FetchResult", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Output", + "type": "{urn:mpeg:mpqf:schema:2008}OutputQueryType", + "type_name": "OutputQueryType", + "definition": { + "kind": "complexType", + "name": "OutputQueryType", + "fields": [ + { + "name": "GlobalComment", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ResultItem", + "type": "{urn:mpeg:mpqf:schema:2008}ResultItemType", + "type_name": "ResultItemType", + "definition": { + "kind": "complexType", + "name": "ResultItemType", + "base": "{urn:mpeg:mpqf:schema:2008}ResultItemBaseType", + "base_definition": { + "kind": "complexType", + "name": "ResultItemBaseType", + "fields": [] + }, + "fields": [ + { + "name": "Comment", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "TextResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "Thumbnail", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "MediaResource", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "Description", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "AggregationResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "FragmentResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "recordNumber", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "rank", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "confidence", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + }, + { + "use": "optional", + "name": "originID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SystemMessage", + "type": "{urn:mpeg:mpqf:schema:2008}SystemMessageType", + "type_name": "SystemMessageType", + "definition": { + "kind": "complexType", + "name": "SystemMessageType", + "fields": [ + { + "name": "Status", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Warning", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Exception", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "currPage", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "default": "1" + }, + { + "use": "optional", + "name": "totalPages", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "default": "1" + }, + { + "use": "optional", + "name": "expirationDate", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Management", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Input", + "type": "{urn:mpeg:mpqf:schema:2008}InputManagementType", + "type_name": "InputManagementType", + "definition": { + "kind": "complexType", + "name": "InputManagementType", + "fields": [ + { + "name": "DesiredCapability", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityType", + "type_name": "CapabilityType", + "definition": { + "kind": "complexType", + "name": "CapabilityType", + "fields": [ + { + "name": "SupportedQFProfile", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExampleMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedResultMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedQueryTypes", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExpressions", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "UsageConditions", + "definition": { + "kind": "complexType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ServiceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Output", + "type": "{urn:mpeg:mpqf:schema:2008}OutputManagementType", + "type_name": "OutputManagementType", + "definition": { + "kind": "complexType", + "name": "OutputManagementType", + "fields": [ + { + "name": "AvailableCapability", + "type": "{urn:mpeg:mpqf:schema:2008}AvailableCapabilityType", + "type_name": "AvailableCapabilityType", + "definition": { + "kind": "complexType", + "name": "AvailableCapabilityType", + "base": "{urn:mpeg:mpqf:schema:2008}CapabilityType", + "base_definition": { + "kind": "complexType", + "name": "CapabilityType", + "fields": [ + { + "name": "SupportedQFProfile", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExampleMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedResultMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedQueryTypes", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExpressions", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "UsageConditions", + "definition": { + "kind": "complexType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "required", + "name": "serviceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SystemMessage", + "type": "{urn:mpeg:mpqf:schema:2008}SystemMessageType", + "type_name": "SystemMessageType", + "definition": { + "kind": "complexType", + "name": "SystemMessageType", + "fields": [ + { + "name": "Status", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Warning", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Exception", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "required", + "name": "mpqfID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Allows to request the results of a previous query\n\t\t\t\t\t\t\t\t\tissued." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/federatedsearch/wsdl}GetSearchResultsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/federatedsearch/wsdl}GetSearchResultsResponse", + "schema": { + "name": "GetSearchResultsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ResultItem", + "type": "{urn:mpeg:mpqf:schema:2008}MpegQueryType", + "type_name": "MpegQueryType", + "definition": { + "kind": "complexType", + "name": "MpegQueryType", + "fields": [ + { + "name": "Query", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Input", + "type": "{urn:mpeg:mpqf:schema:2008}InputQueryType", + "type_name": "InputQueryType", + "definition": { + "kind": "complexType", + "name": "InputQueryType", + "fields": [ + { + "name": "QFDeclaration", + "type": "{urn:mpeg:mpqf:schema:2008}QFDeclarationType", + "type_name": "QFDeclarationType", + "definition": { + "kind": "complexType", + "name": "QFDeclarationType", + "fields": [ + { + "name": "DeclaredField", + "type": "{urn:mpeg:mpqf:schema:2008}DeclaredFieldType", + "type_name": "DeclaredFieldType", + "definition": { + "kind": "complexType", + "name": "DeclaredFieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + }, + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Resource", + "type": "{urn:mpeg:mpqf:schema:2008}ResourceType", + "type_name": "ResourceType", + "definition": { + "kind": "complexType", + "name": "ResourceType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "resourceID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Prefix", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "OutputDescription", + "type": "{urn:mpeg:mpqf:schema:2008}OutputDescriptionType", + "type_name": "OutputDescriptionType", + "definition": { + "kind": "complexType", + "name": "OutputDescriptionType", + "fields": [ + { + "name": "ReqField", + "type": "{urn:mpeg:mpqf:schema:2008}FieldType", + "type_name": "FieldType", + "definition": { + "kind": "complexType", + "name": "FieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fragmentResultName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "fieldREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "resultMode", + "default": "structured" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "ReqAggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF", + "type_name": "IDREF", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "ReqSemanticField", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "GroupBy", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "GroupByField", + "type": "{urn:mpeg:mpqf:schema:2008}FieldType", + "type_name": "FieldType", + "definition": { + "kind": "complexType", + "name": "FieldType", + "base": "{urn:mpeg:mpqf:schema:2008}xPathType", + "base_definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "typeName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fragmentResultName", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "fieldREF", + "type": "{http://www.w3.org/2001/XMLSchema}IDREF" + }, + { + "use": "optional", + "name": "resultMode", + "default": "structured" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Aggregate", + "type": "{urn:mpeg:mpqf:schema:2008}AggregateExpressionType", + "type_name": "AggregateExpressionType", + "definition": { + "kind": "complexType", + "name": "AggregateExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SortBy", + "type": "{urn:mpeg:mpqf:schema:2008}AbstractSortByType", + "type_name": "AbstractSortByType", + "definition": { + "kind": "complexType", + "name": "AbstractSortByType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "order" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "maxPageEntries", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "maxItemCount", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "freeTextUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "thumbnailUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "mediaResourceUse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "outputNameSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "distinct", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "QueryCondition", + "type": "{urn:mpeg:mpqf:schema:2008}QueryConditionType", + "type_name": "QueryConditionType", + "definition": { + "kind": "complexType", + "name": "QueryConditionType", + "fields": [ + { + "name": "EvaluationPath", + "type": "{urn:mpeg:mpqf:schema:2008}xPathType", + "type_name": "xPathType", + "definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TargetMediaType", + "type": "{urn:mpeg:mpqf:schema:2008}mimeType", + "type_name": "mimeType", + "definition": { + "kind": "simpleType", + "name": "mimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "([Xx]\\-)?[!#$%'*+.0-9A-Z\\^-~]+/([Xx]\\- )?[!#$%'*+.0-9A-Z\\^-~\\-]+", + "whiteSpace": "collapse" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Join", + "type": "{urn:mpeg:mpqf:schema:2008}JoinType", + "type_name": "JoinType", + "definition": { + "kind": "complexType", + "name": "JoinType", + "fields": [ + { + "name": "From", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "EvaluationPath", + "type": "{urn:mpeg:mpqf:schema:2008}xPathType", + "type_name": "xPathType", + "definition": { + "kind": "simpleType", + "name": "xPathType", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TargetMediaType", + "type": "{urn:mpeg:mpqf:schema:2008}mimeType", + "type_name": "mimeType", + "definition": { + "kind": "simpleType", + "name": "mimeType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "pattern": "([Xx]\\-)?[!#$%'*+.0-9A-Z\\^-~]+/([Xx]\\- )?[!#$%'*+.0-9A-Z\\^-~\\-]+", + "whiteSpace": "collapse" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Condition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 1, + "max_occurs": 2, + "nillable": false + }, + { + "name": "JoinCondition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "id", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Condition", + "type": "{urn:mpeg:mpqf:schema:2008}BooleanExpressionType", + "type_name": "BooleanExpressionType", + "definition": { + "kind": "complexType", + "name": "BooleanExpressionType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "preferenceValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + }, + "default": "1" + }, + { + "use": "optional", + "name": "thresholdValue", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ServiceSelection", + "type": "{urn:mpeg:mpqf:schema:2008}ServiceSelectionType", + "type_name": "ServiceSelectionType", + "definition": { + "kind": "complexType", + "name": "ServiceSelectionType", + "fields": [ + { + "name": "ServiceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "previousAnswerID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "immediateResponse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "true" + }, + { + "use": "optional", + "name": "streamingResponse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false" + }, + { + "use": "optional", + "name": "timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "FetchResult", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Output", + "type": "{urn:mpeg:mpqf:schema:2008}OutputQueryType", + "type_name": "OutputQueryType", + "definition": { + "kind": "complexType", + "name": "OutputQueryType", + "fields": [ + { + "name": "GlobalComment", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ResultItem", + "type": "{urn:mpeg:mpqf:schema:2008}ResultItemType", + "type_name": "ResultItemType", + "definition": { + "kind": "complexType", + "name": "ResultItemType", + "base": "{urn:mpeg:mpqf:schema:2008}ResultItemBaseType", + "base_definition": { + "kind": "complexType", + "name": "ResultItemBaseType", + "fields": [] + }, + "fields": [ + { + "name": "Comment", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "TextResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "Thumbnail", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "MediaResource", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "Description", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 2, + "nillable": false + }, + { + "name": "AggregationResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "FragmentResult", + "definition": { + "kind": "complexType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "aggregateID", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "name", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "optional", + "name": "fromREF", + "type": "{http://www.w3.org/2001/XMLSchema}string" + }, + { + "use": "required", + "name": "recordNumber", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "rank", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "optional", + "name": "confidence", + "type": "{urn:mpeg:mpqf:schema:2008}zeroToOneType", + "definition": { + "kind": "simpleType", + "name": "zeroToOneType", + "base": "{http://www.w3.org/2001/XMLSchema}float", + "minInclusive": "0.0", + "maxInclusive": "1.0" + } + }, + { + "use": "optional", + "name": "originID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SystemMessage", + "type": "{urn:mpeg:mpqf:schema:2008}SystemMessageType", + "type_name": "SystemMessageType", + "definition": { + "kind": "complexType", + "name": "SystemMessageType", + "fields": [ + { + "name": "Status", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Warning", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Exception", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "currPage", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "default": "1" + }, + { + "use": "optional", + "name": "totalPages", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "default": "1" + }, + { + "use": "optional", + "name": "expirationDate", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Management", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Input", + "type": "{urn:mpeg:mpqf:schema:2008}InputManagementType", + "type_name": "InputManagementType", + "definition": { + "kind": "complexType", + "name": "InputManagementType", + "fields": [ + { + "name": "DesiredCapability", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityType", + "type_name": "CapabilityType", + "definition": { + "kind": "complexType", + "name": "CapabilityType", + "fields": [ + { + "name": "SupportedQFProfile", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExampleMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedResultMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedQueryTypes", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExpressions", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "UsageConditions", + "definition": { + "kind": "complexType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ServiceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Output", + "type": "{urn:mpeg:mpqf:schema:2008}OutputManagementType", + "type_name": "OutputManagementType", + "definition": { + "kind": "complexType", + "name": "OutputManagementType", + "fields": [ + { + "name": "AvailableCapability", + "type": "{urn:mpeg:mpqf:schema:2008}AvailableCapabilityType", + "type_name": "AvailableCapabilityType", + "definition": { + "kind": "complexType", + "name": "AvailableCapabilityType", + "base": "{urn:mpeg:mpqf:schema:2008}CapabilityType", + "base_definition": { + "kind": "complexType", + "name": "CapabilityType", + "fields": [ + { + "name": "SupportedQFProfile", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExampleMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedResultMediaTypes", + "definition": { + "kind": "simpleType", + "item_type": "{urn:mpeg:mpqf:schema:2008}mimeType" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SupportedQueryTypes", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SupportedExpressions", + "type": "{urn:mpeg:mpqf:schema:2008}CapabilityTermType", + "type_name": "CapabilityTermType", + "definition": { + "kind": "complexType", + "name": "CapabilityTermType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageRefList", + "type": "{http://www.w3.org/2001/XMLSchema}IDREFS" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "UsageConditions", + "definition": { + "kind": "complexType", + "base": "{urn:mpeg:mpqf:schema:2008}TermType", + "base_definition": { + "kind": "complexType", + "name": "TermType", + "fields": [ + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Term", + "type": "{urn:mpeg:mpqf:schema:2008}TermType", + "type_name": "TermType", + "recursive": true, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "href", + "type": "{urn:mpeg:mpqf:schema:2008}SimpleTermType", + "definition": { + "kind": "simpleType", + "name": "SimpleTermType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "usageID", + "type": "{http://www.w3.org/2001/XMLSchema}ID" + } + ] + }, + "fields": [], + "attributes": [ + { + "use": "required", + "name": "serviceID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "SystemMessage", + "type": "{urn:mpeg:mpqf:schema:2008}SystemMessageType", + "type_name": "SystemMessageType", + "definition": { + "kind": "complexType", + "name": "SystemMessageType", + "fields": [ + { + "name": "Status", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Warning", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Exception", + "type": "{urn:mpeg:mpqf:schema:2008}InformationType", + "type_name": "InformationType", + "definition": { + "kind": "complexType", + "name": "InformationType", + "fields": [ + { + "name": "Code", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Description", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "queryID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + }, + { + "use": "optional", + "name": "retrievePageNum", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger" + }, + { + "use": "required", + "name": "mpqfID", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Describes a single result returned from a\n\t\t\t\t\t\t\t\t\tresponder." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "FederatedSearchBinding" + }, + { + "name": "RegisterDatabase", + "port_type": "FederatedSearchPort", + "description": null, + "input": { + "message": "{http://www.onvif.org/ver10/federatedsearch/wsdl}RegisterDatabaseRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/federatedsearch/wsdl}RegisterDatabase", + "schema": { + "name": "RegisterDatabase", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DatabaseFeaturesSupported", + "type": "{http://www.onvif.org/ver10/federatedsearch/wsdl}RegisterDatabase", + "type_name": "RegisterDatabase", + "recursive": true, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Describes a predefined set of features supported\n\t\t\t\t\t\t\t\t\tby the database registered." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/federatedsearch/wsdl}RegisterDatabaseResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/federatedsearch/wsdl}RegisterDatabaseResponse", + "schema": { + "name": "RegisterDatabaseResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "FederatedSearchBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/media/wsdl/media.json b/docs/generated/wsdl/ver10/media/wsdl/media.json new file mode 100644 index 00000000..c9a49a51 --- /dev/null +++ b/docs/generated/wsdl/ver10/media/wsdl/media.json @@ -0,0 +1,30947 @@ +{ + "source": "ver10/media/wsdl/media.wsdl", + "target_namespace": "http://www.onvif.org/ver10/media/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "Media", + "description": "Returns the capabilities of the media service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/media/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [ + { + "name": "ProfileCapabilities", + "type": "{http://www.onvif.org/ver10/media/wsdl}ProfileCapabilities", + "type_name": "ProfileCapabilities", + "definition": { + "kind": "complexType", + "name": "ProfileCapabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "MaximumNumberOfProfiles", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of profiles supported." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Media profile capabilities." + }, + { + "name": "StreamingCapabilities", + "type": "{http://www.onvif.org/ver10/media/wsdl}StreamingCapabilities", + "type_name": "StreamingCapabilities", + "definition": { + "kind": "complexType", + "name": "StreamingCapabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "RTPMulticast", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for RTP multicast." + }, + { + "use": "optional", + "name": "RTP_TCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for RTP over TCP." + }, + { + "use": "optional", + "name": "RTP_RTSP_TCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for RTP/RTSP/TCP." + }, + { + "use": "optional", + "name": "NonAggregateControl", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for non aggregate RTSP control." + }, + { + "use": "optional", + "name": "NoRTSPStreaming", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates the device does not support live media streaming via RTSP." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Streaming capabilities." + } + ], + "attributes": [ + { + "use": "optional", + "name": "SnapshotUri", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates if GetSnapshotUri is supported." + }, + { + "use": "optional", + "name": "Rotation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not Rotation feature is supported." + }, + { + "use": "optional", + "name": "VideoSourceMode", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates the support for changing video source mode." + }, + { + "use": "optional", + "name": "OSD", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates if OSD is supported." + }, + { + "use": "optional", + "name": "TemporaryOSDText", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates the support for temporary osd text configuration." + }, + { + "use": "optional", + "name": "EXICompression", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates the support for the Efficient XML Interchange (EXI) binary XML format." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the media service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetVideoSources", + "port_type": "Media", + "description": "This command lists all available physical video inputs of the device.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourcesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSources", + "schema": { + "name": "GetVideoSources", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourcesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourcesResponse", + "schema": { + "name": "GetVideoSourcesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSources", + "type": "{http://www.onvif.org/ver10/schema}VideoSource", + "type_name": "VideoSource", + "definition": { + "kind": "complexType", + "name": "VideoSource", + "description": "Representation of a physical video input.", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Framerate", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Frame rate in frames per second." + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Horizontal and vertical resolution" + }, + { + "name": "Imaging", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettings", + "type_name": "ImagingSettings", + "definition": { + "kind": "complexType", + "name": "ImagingSettings", + "fields": [ + { + "name": "BacklightCompensation", + "type": "{http://www.onvif.org/ver10/schema}BacklightCompensation", + "type_name": "BacklightCompensation", + "definition": { + "kind": "complexType", + "name": "BacklightCompensation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}BacklightCompensationMode", + "type_name": "BacklightCompensationMode", + "definition": { + "kind": "simpleType", + "name": "BacklightCompensationMode", + "description": "Enumeration describing the available backlight compensation modes.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Backlight compensation is disabled." + }, + { + "value": "ON", + "description": "Backlight compensation is enabled." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Backlight compensation mode (on/off)." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter (unit unspecified)." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Enabled/disabled BLC mode (on/off)." + }, + { + "name": "Brightness", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Image brightness (unit unspecified)." + }, + { + "name": "ColorSaturation", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Color saturation of the image (unit unspecified)." + }, + { + "name": "Contrast", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contrast of the image (unit unspecified)." + }, + { + "name": "Exposure", + "type": "{http://www.onvif.org/ver10/schema}Exposure", + "type_name": "Exposure", + "definition": { + "kind": "complexType", + "name": "Exposure", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ExposureMode", + "type_name": "ExposureMode", + "definition": { + "kind": "simpleType", + "name": "ExposureMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Exposure Mode\n\t\t\t\t\t
    \n\t\t\t\t\t\t\t
  • Auto - Enabled the exposure algorithm on the NVT.
    • \n\t\t\t\t\t\t\t
  • Manual - Disabled exposure algorithm on the NVT.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "Priority", + "type": "{http://www.onvif.org/ver10/schema}ExposurePriority", + "type_name": "ExposurePriority", + "definition": { + "kind": "simpleType", + "name": "ExposurePriority", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "LowNoise" + }, + { + "value": "FrameRate" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The exposure priority mode (low noise/framerate)." + }, + { + "name": "Window", + "type": "{http://www.onvif.org/ver10/schema}Rectangle", + "type_name": "Rectangle", + "definition": { + "kind": "complexType", + "name": "Rectangle", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "bottom", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "top", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "right", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "left", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rectangular exposure mask." + }, + { + "name": "MinExposureTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Minimum value of exposure time range allowed to be used by the algorithm." + }, + { + "name": "MaxExposureTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum value of exposure time range allowed to be used by the algorithm." + }, + { + "name": "MinGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Minimum value of the sensor gain range that is allowed to be used by the algorithm." + }, + { + "name": "MaxGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum value of the sensor gain range that is allowed to be used by the algorithm." + }, + { + "name": "MinIris", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Minimum value of the iris range allowed to be used by the algorithm." + }, + { + "name": "MaxIris", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum value of the iris range allowed to be used by the algorithm." + }, + { + "name": "ExposureTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The fixed exposure time used by the image sensor (μs)." + }, + { + "name": "Gain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The fixed gain used by the image sensor (dB)." + }, + { + "name": "Iris", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The fixed attenuation of input light affected by the iris (dB). 0dB maps to a fully opened iris." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Exposure mode of the device." + }, + { + "name": "Focus", + "type": "{http://www.onvif.org/ver10/schema}FocusConfiguration", + "type_name": "FocusConfiguration", + "definition": { + "kind": "complexType", + "name": "FocusConfiguration", + "fields": [ + { + "name": "AutoFocusMode", + "type": "{http://www.onvif.org/ver10/schema}AutoFocusMode", + "type_name": "AutoFocusMode", + "definition": { + "kind": "simpleType", + "name": "AutoFocusMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "DefaultSpeed", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "NearLimit", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to set autofocus near limit (unit: meter)." + }, + { + "name": "FarLimit", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to set autofocus far limit (unit: meter).\nIf set to 0.0, infinity will be used." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Focus configuration." + }, + { + "name": "IrCutFilter", + "type": "{http://www.onvif.org/ver10/schema}IrCutFilterMode", + "type_name": "IrCutFilterMode", + "definition": { + "kind": "simpleType", + "name": "IrCutFilterMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "ON" + }, + { + "value": "OFF" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Infrared Cutoff Filter settings." + }, + { + "name": "Sharpness", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Sharpness of the Video image." + }, + { + "name": "WideDynamicRange", + "type": "{http://www.onvif.org/ver10/schema}WideDynamicRange", + "type_name": "WideDynamicRange", + "definition": { + "kind": "complexType", + "name": "WideDynamicRange", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}WideDynamicMode", + "type_name": "WideDynamicMode", + "definition": { + "kind": "simpleType", + "name": "WideDynamicMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "White dynamic range (on/off)" + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter (unitless)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "WDR settings." + }, + { + "name": "WhiteBalance", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalance", + "type_name": "WhiteBalance", + "definition": { + "kind": "complexType", + "name": "WhiteBalance", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalanceMode", + "type_name": "WhiteBalanceMode", + "definition": { + "kind": "simpleType", + "name": "WhiteBalanceMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Auto whitebalancing mode (auto/manual)." + }, + { + "name": "CrGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rgain (unitless)." + }, + { + "name": "CbGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Bgain (unitless)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "White balance settings." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettingsExtension", + "type_name": "ImagingSettingsExtension", + "definition": { + "kind": "complexType", + "name": "ImagingSettingsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the image sensor." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceExtension", + "type_name": "VideoSourceExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceExtension", + "fields": [ + { + "name": "Imaging", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettings20", + "type_name": "ImagingSettings20", + "definition": { + "kind": "complexType", + "name": "ImagingSettings20", + "description": "Type describing the ImagingSettings of a VideoSource. The supported options and ranges can be obtained via the GetOptions command.", + "fields": [ + { + "name": "BacklightCompensation", + "type": "{http://www.onvif.org/ver10/schema}BacklightCompensation20", + "type_name": "BacklightCompensation20", + "definition": { + "kind": "complexType", + "name": "BacklightCompensation20", + "description": "Type describing whether BLC mode is enabled or disabled (on/off).", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}BacklightCompensationMode", + "type_name": "BacklightCompensationMode", + "definition": { + "kind": "simpleType", + "name": "BacklightCompensationMode", + "description": "Enumeration describing the available backlight compensation modes.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Backlight compensation is disabled." + }, + { + "value": "ON", + "description": "Backlight compensation is enabled." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Backlight compensation mode (on/off)." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter (unit unspecified)." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Enabled/disabled BLC mode (on/off)." + }, + { + "name": "Brightness", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Image brightness (unit unspecified)." + }, + { + "name": "ColorSaturation", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Color saturation of the image (unit unspecified)." + }, + { + "name": "Contrast", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contrast of the image (unit unspecified)." + }, + { + "name": "Exposure", + "type": "{http://www.onvif.org/ver10/schema}Exposure20", + "type_name": "Exposure20", + "definition": { + "kind": "complexType", + "name": "Exposure20", + "description": "Type describing the exposure settings.", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ExposureMode", + "type_name": "ExposureMode", + "definition": { + "kind": "simpleType", + "name": "ExposureMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Exposure Mode\n\t\t\t\t
    \n\t\t\t\t\t\t\t
  • Auto - Enabled the exposure algorithm on the device.
    • \n\t\t\t\t\t\t\t
  • Manual - Disabled exposure algorithm on the device.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "Priority", + "type": "{http://www.onvif.org/ver10/schema}ExposurePriority", + "type_name": "ExposurePriority", + "definition": { + "kind": "simpleType", + "name": "ExposurePriority", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "LowNoise" + }, + { + "value": "FrameRate" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The exposure priority mode (low noise/framerate)." + }, + { + "name": "Window", + "type": "{http://www.onvif.org/ver10/schema}Rectangle", + "type_name": "Rectangle", + "definition": { + "kind": "complexType", + "name": "Rectangle", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "bottom", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "top", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "right", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "left", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Rectangular exposure mask." + }, + { + "name": "MinExposureTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Minimum value of exposure time range allowed to be used by the algorithm." + }, + { + "name": "MaxExposureTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum value of exposure time range allowed to be used by the algorithm." + }, + { + "name": "MinGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Minimum value of the sensor gain range that is allowed to be used by the algorithm." + }, + { + "name": "MaxGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum value of the sensor gain range that is allowed to be used by the algorithm." + }, + { + "name": "MinIris", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Minimum value of the iris range allowed to be used by the algorithm. 0dB maps to a fully opened iris and positive values map to higher attenuation." + }, + { + "name": "MaxIris", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum value of the iris range allowed to be used by the algorithm. 0dB maps to a fully opened iris and positive values map to higher attenuation." + }, + { + "name": "ExposureTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The fixed exposure time used by the image sensor (μs)." + }, + { + "name": "Gain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The fixed gain used by the image sensor (dB)." + }, + { + "name": "Iris", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The fixed attenuation of input light affected by the iris (dB). 0dB maps to a fully opened iris and positive values map to higher attenuation." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Exposure mode of the device." + }, + { + "name": "Focus", + "type": "{http://www.onvif.org/ver10/schema}FocusConfiguration20", + "type_name": "FocusConfiguration20", + "definition": { + "kind": "complexType", + "name": "FocusConfiguration20", + "fields": [ + { + "name": "AutoFocusMode", + "type": "{http://www.onvif.org/ver10/schema}AutoFocusMode", + "type_name": "AutoFocusMode", + "definition": { + "kind": "simpleType", + "name": "AutoFocusMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mode of auto focus.\n\t\t\t\t\t\t
    \n\t\t\t\t\t\t\t
  • AUTO - The device automatically adjusts focus.
    • \n\t\t\t\t\t\t\t
  • MANUAL - The device does not automatically adjust focus.
    • \n\t\t\t\t\t\t
\n\t\t\t\t\t\tNote: for devices supporting both manual and auto operation at the same time manual operation may be supported even if the Mode parameter is set to Auto." + }, + { + "name": "DefaultSpeed", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "NearLimit", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to set autofocus near limit (unit: meter)." + }, + { + "name": "FarLimit", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to set autofocus far limit (unit: meter)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}FocusConfiguration20Extension", + "type_name": "FocusConfiguration20Extension", + "definition": { + "kind": "complexType", + "name": "FocusConfiguration20Extension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "AFMode", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Zero or more modes as defined in enumeration tt:AFModes." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Focus configuration." + }, + { + "name": "IrCutFilter", + "type": "{http://www.onvif.org/ver10/schema}IrCutFilterMode", + "type_name": "IrCutFilterMode", + "definition": { + "kind": "simpleType", + "name": "IrCutFilterMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "ON" + }, + { + "value": "OFF" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Infrared Cutoff Filter settings." + }, + { + "name": "Sharpness", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Sharpness of the Video image." + }, + { + "name": "WideDynamicRange", + "type": "{http://www.onvif.org/ver10/schema}WideDynamicRange20", + "type_name": "WideDynamicRange20", + "definition": { + "kind": "complexType", + "name": "WideDynamicRange20", + "description": "Type describing whether WDR mode is enabled or disabled (on/off).", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}WideDynamicMode", + "type_name": "WideDynamicMode", + "definition": { + "kind": "simpleType", + "name": "WideDynamicMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Wide dynamic range mode (on/off)." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter (unit unspecified)." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "WDR settings." + }, + { + "name": "WhiteBalance", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalance20", + "type_name": "WhiteBalance20", + "definition": { + "kind": "complexType", + "name": "WhiteBalance20", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalanceMode", + "type_name": "WhiteBalanceMode", + "definition": { + "kind": "simpleType", + "name": "WhiteBalanceMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "'AUTO' or 'MANUAL'" + }, + { + "name": "CrGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Rgain (unitless)." + }, + { + "name": "CbGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Bgain (unitless)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalance20Extension", + "type_name": "WhiteBalance20Extension", + "definition": { + "kind": "complexType", + "name": "WhiteBalance20Extension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "White balance settings." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettingsExtension20", + "type_name": "ImagingSettingsExtension20", + "definition": { + "kind": "complexType", + "name": "ImagingSettingsExtension20", + "fields": [ + { + "name": "ImageStabilization", + "type": "{http://www.onvif.org/ver10/schema}ImageStabilization", + "type_name": "ImageStabilization", + "definition": { + "kind": "complexType", + "name": "ImageStabilization", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ImageStabilizationMode", + "type_name": "ImageStabilizationMode", + "definition": { + "kind": "simpleType", + "name": "ImageStabilizationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "AUTO" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Image Stabilization feature." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter (unit unspecified)" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImageStabilizationExtension", + "type_name": "ImageStabilizationExtension", + "definition": { + "kind": "complexType", + "name": "ImageStabilizationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Image Stabilization feature." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettingsExtension202", + "type_name": "ImagingSettingsExtension202", + "definition": { + "kind": "complexType", + "name": "ImagingSettingsExtension202", + "fields": [ + { + "name": "IrCutFilterAutoAdjustment", + "type": "{http://www.onvif.org/ver10/schema}IrCutFilterAutoAdjustment", + "type_name": "IrCutFilterAutoAdjustment", + "definition": { + "kind": "complexType", + "name": "IrCutFilterAutoAdjustment", + "fields": [ + { + "name": "BoundaryType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies which boundaries to automatically toggle Ir cut filter following parameters are applied to. Its options shall be chosen from tt:IrCutFilterAutoBoundaryType." + }, + { + "name": "BoundaryOffset", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Adjusts boundary exposure level for toggling Ir cut filter to on/off specified with unitless normalized value from +1.0 to -1.0. Zero is default and -1.0 is the darkest adjustment (Unitless)." + }, + { + "name": "ResponseTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Delay time of toggling Ir cut filter to on/off after crossing of the boundary exposure levels." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}IrCutFilterAutoAdjustmentExtension", + "type_name": "IrCutFilterAutoAdjustmentExtension", + "definition": { + "kind": "complexType", + "name": "IrCutFilterAutoAdjustmentExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "An optional parameter applied to only auto mode to adjust timing of toggling Ir cut filter." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettingsExtension203", + "type_name": "ImagingSettingsExtension203", + "definition": { + "kind": "complexType", + "name": "ImagingSettingsExtension203", + "fields": [ + { + "name": "ToneCompensation", + "type": "{http://www.onvif.org/ver10/schema}ToneCompensation", + "type_name": "ToneCompensation", + "definition": { + "kind": "complexType", + "name": "ToneCompensation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable or automatic ToneCompensation feature. Its options shall be chosen from tt:ToneCompensationMode Type." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter specified with unitless normalized value from 0.0 to +1.0." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ToneCompensationExtension", + "type_name": "ToneCompensationExtension", + "definition": { + "kind": "complexType", + "name": "ToneCompensationExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Image Contrast Compensation." + }, + { + "name": "Defogging", + "type": "{http://www.onvif.org/ver10/schema}Defogging", + "type_name": "Defogging", + "definition": { + "kind": "complexType", + "name": "Defogging", + "fields": [ + { + "name": "Mode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable or automatic Defogging feature. Its options shall be chosen from tt:DefoggingMode Type." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter specified with unitless normalized value from 0.0 to +1.0." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}DefoggingExtension", + "type_name": "DefoggingExtension", + "definition": { + "kind": "complexType", + "name": "DefoggingExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Image Defogging." + }, + { + "name": "NoiseReduction", + "type": "{http://www.onvif.org/ver10/schema}NoiseReduction", + "type_name": "NoiseReduction", + "definition": { + "kind": "complexType", + "name": "NoiseReduction", + "fields": [ + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Level parameter specified with unitless normalized value from 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Image Noise Reduction." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettingsExtension204", + "type_name": "ImagingSettingsExtension204", + "definition": { + "kind": "complexType", + "name": "ImagingSettingsExtension204", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the image sensor. To be used if imaging service 2.00 is supported." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceExtension2", + "type_name": "VideoSourceExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of existing Video Sources" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioSources", + "port_type": "Media", + "description": "This command lists all available physical audio inputs of the device.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourcesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSources", + "schema": { + "name": "GetAudioSources", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourcesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourcesResponse", + "schema": { + "name": "GetAudioSourcesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AudioSources", + "type": "{http://www.onvif.org/ver10/schema}AudioSource", + "type_name": "AudioSource", + "definition": { + "kind": "complexType", + "name": "AudioSource", + "description": "Representation of a physical audio input.", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Channels", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "number of available audio channels. (1: mono, 2: stereo)" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of existing Audio Sources" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioOutputs", + "port_type": "Media", + "description": "This command lists all available physical audio outputs of the device.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputs", + "schema": { + "name": "GetAudioOutputs", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputsResponse", + "schema": { + "name": "GetAudioOutputsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AudioOutputs", + "type": "{http://www.onvif.org/ver10/schema}AudioOutput", + "type_name": "AudioOutput", + "definition": { + "kind": "complexType", + "name": "AudioOutput", + "description": "Representation of a physical audio outputs.", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of existing Audio Outputs" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "CreateProfile", + "port_type": "Media", + "description": "This operation creates a new empty media profile. The media profile shall be created in the device and shall be persistent (remain after reboot). A created profile shall be deletable and a device shall set the \"fixed\" attribute to false in the returned Profile.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}CreateProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}CreateProfile", + "schema": { + "name": "CreateProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "friendly name of the profile to be created" + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional token, specifying the unique identifier of the new profile.
A device supports at least a token length of 12 characters and characters \"A-Z\" | \"a-z\" | \"0-9\" | \"-.\"." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}CreateProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}CreateProfileResponse", + "schema": { + "name": "CreateProfileResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Profile", + "type": "{http://www.onvif.org/ver10/schema}Profile", + "type_name": "Profile", + "definition": { + "kind": "complexType", + "name": "Profile", + "description": "A media profile consists of a set of media configurations. Media profiles are used by a client\n\t\t\tto configure properties of a media stream from an NVT.
\n\t\t\tAn NVT shall provide at least one media profile at boot. An NVT should provide \"ready to use\"\n\t\t\tprofiles for the most common media configurations that the device offers.
\n\t\t\tA profile consists of a set of interconnected configuration entities. Configurations are provided\n\t\t\tby the NVT and can be either static or created dynamically by the NVT. For example, the\n\t\t\tdynamic configurations can be created by the NVT depending on current available encoding\n\t\t\tresources.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name of the profile." + }, + { + "name": "VideoSourceConfiguration", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfiguration", + "type_name": "VideoSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the physical input." + }, + { + "name": "Bounds", + "type": "{http://www.onvif.org/ver10/schema}IntRectangle", + "type_name": "IntRectangle", + "definition": { + "kind": "complexType", + "name": "IntRectangle", + "description": "Rectangle defined by lower left corner position and size. Units are pixel.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "width", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "height", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension", + "type_name": "VideoSourceConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}Rotate", + "type_name": "Rotate", + "definition": { + "kind": "complexType", + "name": "Rotate", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Rotation feature." + }, + { + "name": "Degree", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateExtension", + "type_name": "RotateExtension", + "definition": { + "kind": "complexType", + "name": "RotateExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
\n\t\t\t\twhen Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rotation of captured image.\n\t\t\t\t\t\tWhat resolutions a device supports shall be unaffected by the Rotate parameters.
\n\t\t\t\t\t\tIf a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
\n\t\t\t\t\t\tThe device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition:\n\t\t\t\t\t\tif Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension2", + "type_name": "VideoSourceConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension2", + "fields": [ + { + "name": "LensDescription", + "type": "{http://www.onvif.org/ver10/schema}LensDescription", + "type_name": "LensDescription", + "definition": { + "kind": "complexType", + "name": "LensDescription", + "fields": [ + { + "name": "Offset", + "type": "{http://www.onvif.org/ver10/schema}LensOffset", + "type_name": "LensOffset", + "definition": { + "kind": "complexType", + "name": "LensOffset", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional horizontal offset of the lens center in normalized coordinates." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional vertical offset of the lens center in normalized coordinates." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Offset of the lens center to the imager center in normalized coordinates." + }, + { + "name": "Projection", + "type": "{http://www.onvif.org/ver10/schema}LensProjection", + "type_name": "LensProjection", + "definition": { + "kind": "complexType", + "name": "LensProjection", + "fields": [ + { + "name": "Angle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Angle of incidence." + }, + { + "name": "Radius", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mapping radius as a consequence of the emergent angle." + }, + { + "name": "Transmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ray absorption at the given angle due to vignetting. A value of one means no absorption." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation\n\t\t\t\t\tover the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius.\n\t\t\t\t\tItems outside the last projection Radius shall be assumed to be invisible (black)." + }, + { + "name": "XFactor", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Compensation of the x coordinate needed for the ONVIF normalized coordinate system." + } + ], + "attributes": [ + { + "use": "optional", + "name": "FocalLength", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional focal length of the optical system." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional element describing the geometric lens distortion. Multiple instances for future variable lens support." + }, + { + "name": "SceneOrientation", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientation", + "type_name": "SceneOrientation", + "definition": { + "kind": "complexType", + "name": "SceneOrientation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to assign the way the camera determines the scene orientation." + }, + { + "name": "Orientation", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field\n\t\t\t\t\t\tis optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required\n\t\t\t\t\t\tand the device will return an InvalidArgs fault if missing." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element describing the scene orientation in the camera's field of view." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "ViewMode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Video input." + }, + { + "name": "AudioSourceConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfiguration", + "type_name": "AudioSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Audio Source the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio input." + }, + { + "name": "VideoEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfiguration", + "type_name": "VideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoding", + "type_name": "VideoEncoding", + "definition": { + "kind": "simpleType", + "name": "VideoEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "JPEG" + }, + { + "value": "MPEG4" + }, + { + "value": "H264" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Used video codec, either Jpeg, H.264 or Mpeg4" + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl", + "type_name": "VideoRateControl", + "definition": { + "kind": "complexType", + "name": "VideoRateControl", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor." + }, + { + "name": "EncodingInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)" + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum output bitrate in kbps." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Configuration", + "type_name": "Mpeg4Configuration", + "definition": { + "kind": "complexType", + "name": "Mpeg4Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "Mpeg4Profile", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Mpeg4 related parameters." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Configuration", + "type_name": "H264Configuration", + "definition": { + "kind": "complexType", + "name": "H264Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "H264Profile", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the H.264 profile, either baseline, main, extended or high" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure H.264 related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related video stream" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Video encoder." + }, + { + "name": "AudioEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio encoder." + }, + { + "name": "VideoAnalyticsConfiguration", + "type": "{http://www.onvif.org/ver10/schema}VideoAnalyticsConfiguration", + "type_name": "VideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoAnalyticsConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfiguration", + "type_name": "RuleEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfiguration", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfigurationExtension", + "type_name": "RuleEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the video analytics module and rule engine." + }, + { + "name": "PTZConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PTZConfiguration", + "type_name": "PTZConfiguration", + "definition": { + "kind": "complexType", + "name": "PTZConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "NodeToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A mandatory reference to the PTZ Node that the PTZ Configuration belongs to." + }, + { + "name": "DefaultAbsolutePantTiltPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default." + }, + { + "name": "DefaultAbsoluteZoomPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default." + }, + { + "name": "DefaultRelativePanTiltTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default." + }, + { + "name": "DefaultRelativeZoomTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default." + }, + { + "name": "DefaultContinuousPanTiltVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default." + }, + { + "name": "DefaultContinuousZoomVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default." + }, + { + "name": "DefaultPTZSpeed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds." + }, + { + "name": "DefaultPTZTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops." + }, + { + "name": "PanTiltLimits", + "type": "{http://www.onvif.org/ver10/schema}PanTiltLimits", + "type_name": "PanTiltLimits", + "definition": { + "kind": "complexType", + "name": "PanTiltLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of pan tilt limits." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Pan/Tilt limits element should be present for a PTZ Node that supports an absolute Pan/Tilt. If the element is present it signals the support for configurable Pan/Tilt limits. If limits are enabled, the Pan/Tilt movements shall always stay within the specified range. The Pan/Tilt limits are disabled by setting the limits to -INF or +INF." + }, + { + "name": "ZoomLimits", + "type": "{http://www.onvif.org/ver10/schema}ZoomLimits", + "type_name": "ZoomLimits", + "definition": { + "kind": "complexType", + "name": "ZoomLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of zoom limit" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Zoom limits element should be present for a PTZ Node that supports absolute zoom. If the element is present it signals the supports for configurable Zoom limits. If limits are enabled the zoom movements shall always stay within the specified range. The Zoom limits are disabled by settings the limits to -INF and +INF." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension", + "type_name": "PTZConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension", + "fields": [ + { + "name": "PTControlDirection", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirection", + "type_name": "PTControlDirection", + "definition": { + "kind": "complexType", + "name": "PTControlDirection", + "fields": [ + { + "name": "EFlip", + "type": "{http://www.onvif.org/ver10/schema}EFlip", + "type_name": "EFlip", + "definition": { + "kind": "complexType", + "name": "EFlip", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}EFlipMode", + "type_name": "EFlipMode", + "definition": { + "kind": "simpleType", + "name": "EFlipMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable E-Flip feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for E-Flip." + }, + { + "name": "Reverse", + "type": "{http://www.onvif.org/ver10/schema}Reverse", + "type_name": "Reverse", + "definition": { + "kind": "complexType", + "name": "Reverse", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReverseMode", + "type_name": "ReverseMode", + "definition": { + "kind": "simpleType", + "name": "ReverseMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "AUTO" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Reverse feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for reversing of PT Control Direction." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirectionExtension", + "type_name": "PTControlDirectionExtension", + "definition": { + "kind": "complexType", + "name": "PTControlDirectionExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure PT Control Direction related features." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension2", + "type_name": "PTZConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "MoveRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when moving." + }, + { + "use": "optional", + "name": "PresetRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when recalling presets." + }, + { + "use": "optional", + "name": "PresetTourRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when executing PresetTours." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the pan tilt zoom unit." + }, + { + "name": "MetadataConfiguration", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfiguration", + "type_name": "MetadataConfiguration", + "definition": { + "kind": "complexType", + "name": "MetadataConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "PTZStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZFilter", + "type_name": "PTZFilter", + "definition": { + "kind": "complexType", + "name": "PTZFilter", + "fields": [ + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN)." + }, + { + "name": "Position", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ position." + }, + { + "name": "FieldOfView", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the field-of-view information." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which PTZ related data is to include in the metadata stream." + }, + { + "name": "Events", + "type": "{http://www.onvif.org/ver10/schema}EventSubscription", + "type_name": "EventSubscription", + "definition": { + "kind": "complexType", + "name": "EventSubscription", + "description": "Subscription handling in the same way as base notification subscription.", + "fields": [ + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure the streaming of events. A client might be interested in receiving all,\n\t\t\t\t\t\t\t\tnone or some of the events produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all events: Include the Events element but do not include a filter.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no events: Do not include the Events element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some events: Include the Events element and include a filter in the element.
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Analytics", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)" + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored)" + }, + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indication which AnalyticsModules shall output metadata.\n\t\t\t\t\t\t\tNote that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration." + }, + { + "name": "SensorData", + "type": "{http://www.onvif.org/ver10/schema}SensorDataFilter", + "type_name": "SensorDataFilter", + "definition": { + "kind": "complexType", + "name": "SensorDataFilter", + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:\n\t\t\t\t
    \n\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t
", + "fields": [ + { + "name": "SensorID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them)." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, \n\t\t\t\t\t\t\t\tnone or some of the sensor data produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationExtension", + "type_name": "MetadataConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "CompressionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType." + }, + { + "use": "optional", + "name": "GeoLocation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target." + }, + { + "use": "optional", + "name": "ShapePolygon", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the generated metadata stream should contain shape information as polygon." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the metadata stream." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ProfileExtension", + "type_name": "ProfileExtension", + "definition": { + "kind": "complexType", + "name": "ProfileExtension", + "fields": [ + { + "name": "AudioOutputConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfiguration", + "type_name": "AudioOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio output." + }, + { + "name": "SendPrimacy", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\t\t\tneeds to be switched.\n\t\t\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio output." + }, + { + "name": "AudioDecoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfiguration", + "type_name": "AudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfiguration", + "description": "The Audio Decoder Configuration does not contain any that parameter to configure the\ndecoding .A decoder shall decode every data it receives (according to its capabilities).", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio decoder." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ProfileExtension2", + "type_name": "ProfileExtension2", + "definition": { + "kind": "complexType", + "name": "ProfileExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Extensions defined in ONVIF 2.0" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of the profile." + }, + { + "use": "optional", + "name": "fixed", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true signals that the profile cannot be deleted. Default is false." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "returns the new created profile" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetProfile", + "port_type": "Media", + "description": "If the profile token is already known, a profile can be fetched through the GetProfile command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetProfile", + "schema": { + "name": "GetProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This command requests a specific profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetProfileResponse", + "schema": { + "name": "GetProfileResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Profile", + "type": "{http://www.onvif.org/ver10/schema}Profile", + "type_name": "Profile", + "definition": { + "kind": "complexType", + "name": "Profile", + "description": "A media profile consists of a set of media configurations. Media profiles are used by a client\n\t\t\tto configure properties of a media stream from an NVT.
\n\t\t\tAn NVT shall provide at least one media profile at boot. An NVT should provide \"ready to use\"\n\t\t\tprofiles for the most common media configurations that the device offers.
\n\t\t\tA profile consists of a set of interconnected configuration entities. Configurations are provided\n\t\t\tby the NVT and can be either static or created dynamically by the NVT. For example, the\n\t\t\tdynamic configurations can be created by the NVT depending on current available encoding\n\t\t\tresources.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name of the profile." + }, + { + "name": "VideoSourceConfiguration", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfiguration", + "type_name": "VideoSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the physical input." + }, + { + "name": "Bounds", + "type": "{http://www.onvif.org/ver10/schema}IntRectangle", + "type_name": "IntRectangle", + "definition": { + "kind": "complexType", + "name": "IntRectangle", + "description": "Rectangle defined by lower left corner position and size. Units are pixel.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "width", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "height", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension", + "type_name": "VideoSourceConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}Rotate", + "type_name": "Rotate", + "definition": { + "kind": "complexType", + "name": "Rotate", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Rotation feature." + }, + { + "name": "Degree", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateExtension", + "type_name": "RotateExtension", + "definition": { + "kind": "complexType", + "name": "RotateExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
\n\t\t\t\twhen Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rotation of captured image.\n\t\t\t\t\t\tWhat resolutions a device supports shall be unaffected by the Rotate parameters.
\n\t\t\t\t\t\tIf a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
\n\t\t\t\t\t\tThe device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition:\n\t\t\t\t\t\tif Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension2", + "type_name": "VideoSourceConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension2", + "fields": [ + { + "name": "LensDescription", + "type": "{http://www.onvif.org/ver10/schema}LensDescription", + "type_name": "LensDescription", + "definition": { + "kind": "complexType", + "name": "LensDescription", + "fields": [ + { + "name": "Offset", + "type": "{http://www.onvif.org/ver10/schema}LensOffset", + "type_name": "LensOffset", + "definition": { + "kind": "complexType", + "name": "LensOffset", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional horizontal offset of the lens center in normalized coordinates." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional vertical offset of the lens center in normalized coordinates." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Offset of the lens center to the imager center in normalized coordinates." + }, + { + "name": "Projection", + "type": "{http://www.onvif.org/ver10/schema}LensProjection", + "type_name": "LensProjection", + "definition": { + "kind": "complexType", + "name": "LensProjection", + "fields": [ + { + "name": "Angle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Angle of incidence." + }, + { + "name": "Radius", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mapping radius as a consequence of the emergent angle." + }, + { + "name": "Transmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ray absorption at the given angle due to vignetting. A value of one means no absorption." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation\n\t\t\t\t\tover the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius.\n\t\t\t\t\tItems outside the last projection Radius shall be assumed to be invisible (black)." + }, + { + "name": "XFactor", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Compensation of the x coordinate needed for the ONVIF normalized coordinate system." + } + ], + "attributes": [ + { + "use": "optional", + "name": "FocalLength", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional focal length of the optical system." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional element describing the geometric lens distortion. Multiple instances for future variable lens support." + }, + { + "name": "SceneOrientation", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientation", + "type_name": "SceneOrientation", + "definition": { + "kind": "complexType", + "name": "SceneOrientation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to assign the way the camera determines the scene orientation." + }, + { + "name": "Orientation", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field\n\t\t\t\t\t\tis optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required\n\t\t\t\t\t\tand the device will return an InvalidArgs fault if missing." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element describing the scene orientation in the camera's field of view." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "ViewMode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Video input." + }, + { + "name": "AudioSourceConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfiguration", + "type_name": "AudioSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Audio Source the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio input." + }, + { + "name": "VideoEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfiguration", + "type_name": "VideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoding", + "type_name": "VideoEncoding", + "definition": { + "kind": "simpleType", + "name": "VideoEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "JPEG" + }, + { + "value": "MPEG4" + }, + { + "value": "H264" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Used video codec, either Jpeg, H.264 or Mpeg4" + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl", + "type_name": "VideoRateControl", + "definition": { + "kind": "complexType", + "name": "VideoRateControl", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor." + }, + { + "name": "EncodingInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)" + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum output bitrate in kbps." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Configuration", + "type_name": "Mpeg4Configuration", + "definition": { + "kind": "complexType", + "name": "Mpeg4Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "Mpeg4Profile", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Mpeg4 related parameters." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Configuration", + "type_name": "H264Configuration", + "definition": { + "kind": "complexType", + "name": "H264Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "H264Profile", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the H.264 profile, either baseline, main, extended or high" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure H.264 related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related video stream" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Video encoder." + }, + { + "name": "AudioEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio encoder." + }, + { + "name": "VideoAnalyticsConfiguration", + "type": "{http://www.onvif.org/ver10/schema}VideoAnalyticsConfiguration", + "type_name": "VideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoAnalyticsConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfiguration", + "type_name": "RuleEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfiguration", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfigurationExtension", + "type_name": "RuleEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the video analytics module and rule engine." + }, + { + "name": "PTZConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PTZConfiguration", + "type_name": "PTZConfiguration", + "definition": { + "kind": "complexType", + "name": "PTZConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "NodeToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A mandatory reference to the PTZ Node that the PTZ Configuration belongs to." + }, + { + "name": "DefaultAbsolutePantTiltPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default." + }, + { + "name": "DefaultAbsoluteZoomPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default." + }, + { + "name": "DefaultRelativePanTiltTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default." + }, + { + "name": "DefaultRelativeZoomTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default." + }, + { + "name": "DefaultContinuousPanTiltVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default." + }, + { + "name": "DefaultContinuousZoomVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default." + }, + { + "name": "DefaultPTZSpeed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds." + }, + { + "name": "DefaultPTZTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops." + }, + { + "name": "PanTiltLimits", + "type": "{http://www.onvif.org/ver10/schema}PanTiltLimits", + "type_name": "PanTiltLimits", + "definition": { + "kind": "complexType", + "name": "PanTiltLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of pan tilt limits." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Pan/Tilt limits element should be present for a PTZ Node that supports an absolute Pan/Tilt. If the element is present it signals the support for configurable Pan/Tilt limits. If limits are enabled, the Pan/Tilt movements shall always stay within the specified range. The Pan/Tilt limits are disabled by setting the limits to -INF or +INF." + }, + { + "name": "ZoomLimits", + "type": "{http://www.onvif.org/ver10/schema}ZoomLimits", + "type_name": "ZoomLimits", + "definition": { + "kind": "complexType", + "name": "ZoomLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of zoom limit" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Zoom limits element should be present for a PTZ Node that supports absolute zoom. If the element is present it signals the supports for configurable Zoom limits. If limits are enabled the zoom movements shall always stay within the specified range. The Zoom limits are disabled by settings the limits to -INF and +INF." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension", + "type_name": "PTZConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension", + "fields": [ + { + "name": "PTControlDirection", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirection", + "type_name": "PTControlDirection", + "definition": { + "kind": "complexType", + "name": "PTControlDirection", + "fields": [ + { + "name": "EFlip", + "type": "{http://www.onvif.org/ver10/schema}EFlip", + "type_name": "EFlip", + "definition": { + "kind": "complexType", + "name": "EFlip", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}EFlipMode", + "type_name": "EFlipMode", + "definition": { + "kind": "simpleType", + "name": "EFlipMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable E-Flip feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for E-Flip." + }, + { + "name": "Reverse", + "type": "{http://www.onvif.org/ver10/schema}Reverse", + "type_name": "Reverse", + "definition": { + "kind": "complexType", + "name": "Reverse", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReverseMode", + "type_name": "ReverseMode", + "definition": { + "kind": "simpleType", + "name": "ReverseMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "AUTO" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Reverse feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for reversing of PT Control Direction." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirectionExtension", + "type_name": "PTControlDirectionExtension", + "definition": { + "kind": "complexType", + "name": "PTControlDirectionExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure PT Control Direction related features." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension2", + "type_name": "PTZConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "MoveRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when moving." + }, + { + "use": "optional", + "name": "PresetRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when recalling presets." + }, + { + "use": "optional", + "name": "PresetTourRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when executing PresetTours." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the pan tilt zoom unit." + }, + { + "name": "MetadataConfiguration", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfiguration", + "type_name": "MetadataConfiguration", + "definition": { + "kind": "complexType", + "name": "MetadataConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "PTZStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZFilter", + "type_name": "PTZFilter", + "definition": { + "kind": "complexType", + "name": "PTZFilter", + "fields": [ + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN)." + }, + { + "name": "Position", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ position." + }, + { + "name": "FieldOfView", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the field-of-view information." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which PTZ related data is to include in the metadata stream." + }, + { + "name": "Events", + "type": "{http://www.onvif.org/ver10/schema}EventSubscription", + "type_name": "EventSubscription", + "definition": { + "kind": "complexType", + "name": "EventSubscription", + "description": "Subscription handling in the same way as base notification subscription.", + "fields": [ + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure the streaming of events. A client might be interested in receiving all,\n\t\t\t\t\t\t\t\tnone or some of the events produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all events: Include the Events element but do not include a filter.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no events: Do not include the Events element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some events: Include the Events element and include a filter in the element.
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Analytics", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)" + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored)" + }, + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indication which AnalyticsModules shall output metadata.\n\t\t\t\t\t\t\tNote that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration." + }, + { + "name": "SensorData", + "type": "{http://www.onvif.org/ver10/schema}SensorDataFilter", + "type_name": "SensorDataFilter", + "definition": { + "kind": "complexType", + "name": "SensorDataFilter", + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:\n\t\t\t\t
    \n\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t
", + "fields": [ + { + "name": "SensorID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them)." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, \n\t\t\t\t\t\t\t\tnone or some of the sensor data produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationExtension", + "type_name": "MetadataConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "CompressionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType." + }, + { + "use": "optional", + "name": "GeoLocation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target." + }, + { + "use": "optional", + "name": "ShapePolygon", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the generated metadata stream should contain shape information as polygon." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the metadata stream." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ProfileExtension", + "type_name": "ProfileExtension", + "definition": { + "kind": "complexType", + "name": "ProfileExtension", + "fields": [ + { + "name": "AudioOutputConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfiguration", + "type_name": "AudioOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio output." + }, + { + "name": "SendPrimacy", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\t\t\tneeds to be switched.\n\t\t\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio output." + }, + { + "name": "AudioDecoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfiguration", + "type_name": "AudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfiguration", + "description": "The Audio Decoder Configuration does not contain any that parameter to configure the\ndecoding .A decoder shall decode every data it receives (according to its capabilities).", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio decoder." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ProfileExtension2", + "type_name": "ProfileExtension2", + "definition": { + "kind": "complexType", + "name": "ProfileExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Extensions defined in ONVIF 2.0" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of the profile." + }, + { + "use": "optional", + "name": "fixed", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true signals that the profile cannot be deleted. Default is false." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Returns the requested media profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetProfiles", + "port_type": "Media", + "description": "Any endpoint can ask for the existing media profiles of a device using the GetProfiles command. Pre-configured or dynamically configured profiles can be retrieved using this command. This command lists all configured profiles in a device. The client does not need to know the media profile in order to use the command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetProfilesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetProfiles", + "schema": { + "name": "GetProfiles", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetProfilesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetProfilesResponse", + "schema": { + "name": "GetProfilesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Profiles", + "type": "{http://www.onvif.org/ver10/schema}Profile", + "type_name": "Profile", + "definition": { + "kind": "complexType", + "name": "Profile", + "description": "A media profile consists of a set of media configurations. Media profiles are used by a client\n\t\t\tto configure properties of a media stream from an NVT.
\n\t\t\tAn NVT shall provide at least one media profile at boot. An NVT should provide \"ready to use\"\n\t\t\tprofiles for the most common media configurations that the device offers.
\n\t\t\tA profile consists of a set of interconnected configuration entities. Configurations are provided\n\t\t\tby the NVT and can be either static or created dynamically by the NVT. For example, the\n\t\t\tdynamic configurations can be created by the NVT depending on current available encoding\n\t\t\tresources.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name of the profile." + }, + { + "name": "VideoSourceConfiguration", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfiguration", + "type_name": "VideoSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the physical input." + }, + { + "name": "Bounds", + "type": "{http://www.onvif.org/ver10/schema}IntRectangle", + "type_name": "IntRectangle", + "definition": { + "kind": "complexType", + "name": "IntRectangle", + "description": "Rectangle defined by lower left corner position and size. Units are pixel.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "width", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "height", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension", + "type_name": "VideoSourceConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}Rotate", + "type_name": "Rotate", + "definition": { + "kind": "complexType", + "name": "Rotate", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Rotation feature." + }, + { + "name": "Degree", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateExtension", + "type_name": "RotateExtension", + "definition": { + "kind": "complexType", + "name": "RotateExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
\n\t\t\t\twhen Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rotation of captured image.\n\t\t\t\t\t\tWhat resolutions a device supports shall be unaffected by the Rotate parameters.
\n\t\t\t\t\t\tIf a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
\n\t\t\t\t\t\tThe device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition:\n\t\t\t\t\t\tif Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension2", + "type_name": "VideoSourceConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension2", + "fields": [ + { + "name": "LensDescription", + "type": "{http://www.onvif.org/ver10/schema}LensDescription", + "type_name": "LensDescription", + "definition": { + "kind": "complexType", + "name": "LensDescription", + "fields": [ + { + "name": "Offset", + "type": "{http://www.onvif.org/ver10/schema}LensOffset", + "type_name": "LensOffset", + "definition": { + "kind": "complexType", + "name": "LensOffset", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional horizontal offset of the lens center in normalized coordinates." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional vertical offset of the lens center in normalized coordinates." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Offset of the lens center to the imager center in normalized coordinates." + }, + { + "name": "Projection", + "type": "{http://www.onvif.org/ver10/schema}LensProjection", + "type_name": "LensProjection", + "definition": { + "kind": "complexType", + "name": "LensProjection", + "fields": [ + { + "name": "Angle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Angle of incidence." + }, + { + "name": "Radius", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mapping radius as a consequence of the emergent angle." + }, + { + "name": "Transmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ray absorption at the given angle due to vignetting. A value of one means no absorption." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation\n\t\t\t\t\tover the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius.\n\t\t\t\t\tItems outside the last projection Radius shall be assumed to be invisible (black)." + }, + { + "name": "XFactor", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Compensation of the x coordinate needed for the ONVIF normalized coordinate system." + } + ], + "attributes": [ + { + "use": "optional", + "name": "FocalLength", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional focal length of the optical system." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional element describing the geometric lens distortion. Multiple instances for future variable lens support." + }, + { + "name": "SceneOrientation", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientation", + "type_name": "SceneOrientation", + "definition": { + "kind": "complexType", + "name": "SceneOrientation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to assign the way the camera determines the scene orientation." + }, + { + "name": "Orientation", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field\n\t\t\t\t\t\tis optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required\n\t\t\t\t\t\tand the device will return an InvalidArgs fault if missing." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element describing the scene orientation in the camera's field of view." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "ViewMode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Video input." + }, + { + "name": "AudioSourceConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfiguration", + "type_name": "AudioSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Audio Source the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio input." + }, + { + "name": "VideoEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfiguration", + "type_name": "VideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoding", + "type_name": "VideoEncoding", + "definition": { + "kind": "simpleType", + "name": "VideoEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "JPEG" + }, + { + "value": "MPEG4" + }, + { + "value": "H264" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Used video codec, either Jpeg, H.264 or Mpeg4" + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl", + "type_name": "VideoRateControl", + "definition": { + "kind": "complexType", + "name": "VideoRateControl", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor." + }, + { + "name": "EncodingInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)" + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum output bitrate in kbps." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Configuration", + "type_name": "Mpeg4Configuration", + "definition": { + "kind": "complexType", + "name": "Mpeg4Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "Mpeg4Profile", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Mpeg4 related parameters." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Configuration", + "type_name": "H264Configuration", + "definition": { + "kind": "complexType", + "name": "H264Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "H264Profile", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the H.264 profile, either baseline, main, extended or high" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure H.264 related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related video stream" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Video encoder." + }, + { + "name": "AudioEncoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio encoder." + }, + { + "name": "VideoAnalyticsConfiguration", + "type": "{http://www.onvif.org/ver10/schema}VideoAnalyticsConfiguration", + "type_name": "VideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoAnalyticsConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfiguration", + "type_name": "RuleEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfiguration", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfigurationExtension", + "type_name": "RuleEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the video analytics module and rule engine." + }, + { + "name": "PTZConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PTZConfiguration", + "type_name": "PTZConfiguration", + "definition": { + "kind": "complexType", + "name": "PTZConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "NodeToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A mandatory reference to the PTZ Node that the PTZ Configuration belongs to." + }, + { + "name": "DefaultAbsolutePantTiltPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default." + }, + { + "name": "DefaultAbsoluteZoomPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default." + }, + { + "name": "DefaultRelativePanTiltTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default." + }, + { + "name": "DefaultRelativeZoomTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default." + }, + { + "name": "DefaultContinuousPanTiltVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default." + }, + { + "name": "DefaultContinuousZoomVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default." + }, + { + "name": "DefaultPTZSpeed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds." + }, + { + "name": "DefaultPTZTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops." + }, + { + "name": "PanTiltLimits", + "type": "{http://www.onvif.org/ver10/schema}PanTiltLimits", + "type_name": "PanTiltLimits", + "definition": { + "kind": "complexType", + "name": "PanTiltLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of pan tilt limits." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Pan/Tilt limits element should be present for a PTZ Node that supports an absolute Pan/Tilt. If the element is present it signals the support for configurable Pan/Tilt limits. If limits are enabled, the Pan/Tilt movements shall always stay within the specified range. The Pan/Tilt limits are disabled by setting the limits to -INF or +INF." + }, + { + "name": "ZoomLimits", + "type": "{http://www.onvif.org/ver10/schema}ZoomLimits", + "type_name": "ZoomLimits", + "definition": { + "kind": "complexType", + "name": "ZoomLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of zoom limit" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Zoom limits element should be present for a PTZ Node that supports absolute zoom. If the element is present it signals the supports for configurable Zoom limits. If limits are enabled the zoom movements shall always stay within the specified range. The Zoom limits are disabled by settings the limits to -INF and +INF." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension", + "type_name": "PTZConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension", + "fields": [ + { + "name": "PTControlDirection", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirection", + "type_name": "PTControlDirection", + "definition": { + "kind": "complexType", + "name": "PTControlDirection", + "fields": [ + { + "name": "EFlip", + "type": "{http://www.onvif.org/ver10/schema}EFlip", + "type_name": "EFlip", + "definition": { + "kind": "complexType", + "name": "EFlip", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}EFlipMode", + "type_name": "EFlipMode", + "definition": { + "kind": "simpleType", + "name": "EFlipMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable E-Flip feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for E-Flip." + }, + { + "name": "Reverse", + "type": "{http://www.onvif.org/ver10/schema}Reverse", + "type_name": "Reverse", + "definition": { + "kind": "complexType", + "name": "Reverse", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReverseMode", + "type_name": "ReverseMode", + "definition": { + "kind": "simpleType", + "name": "ReverseMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "AUTO" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Reverse feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for reversing of PT Control Direction." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirectionExtension", + "type_name": "PTControlDirectionExtension", + "definition": { + "kind": "complexType", + "name": "PTControlDirectionExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure PT Control Direction related features." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension2", + "type_name": "PTZConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "MoveRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when moving." + }, + { + "use": "optional", + "name": "PresetRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when recalling presets." + }, + { + "use": "optional", + "name": "PresetTourRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when executing PresetTours." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the pan tilt zoom unit." + }, + { + "name": "MetadataConfiguration", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfiguration", + "type_name": "MetadataConfiguration", + "definition": { + "kind": "complexType", + "name": "MetadataConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "PTZStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZFilter", + "type_name": "PTZFilter", + "definition": { + "kind": "complexType", + "name": "PTZFilter", + "fields": [ + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN)." + }, + { + "name": "Position", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ position." + }, + { + "name": "FieldOfView", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the field-of-view information." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which PTZ related data is to include in the metadata stream." + }, + { + "name": "Events", + "type": "{http://www.onvif.org/ver10/schema}EventSubscription", + "type_name": "EventSubscription", + "definition": { + "kind": "complexType", + "name": "EventSubscription", + "description": "Subscription handling in the same way as base notification subscription.", + "fields": [ + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure the streaming of events. A client might be interested in receiving all,\n\t\t\t\t\t\t\t\tnone or some of the events produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all events: Include the Events element but do not include a filter.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no events: Do not include the Events element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some events: Include the Events element and include a filter in the element.
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Analytics", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)" + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored)" + }, + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indication which AnalyticsModules shall output metadata.\n\t\t\t\t\t\t\tNote that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration." + }, + { + "name": "SensorData", + "type": "{http://www.onvif.org/ver10/schema}SensorDataFilter", + "type_name": "SensorDataFilter", + "definition": { + "kind": "complexType", + "name": "SensorDataFilter", + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:\n\t\t\t\t
    \n\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t
", + "fields": [ + { + "name": "SensorID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them)." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, \n\t\t\t\t\t\t\t\tnone or some of the sensor data produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationExtension", + "type_name": "MetadataConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "CompressionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType." + }, + { + "use": "optional", + "name": "GeoLocation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target." + }, + { + "use": "optional", + "name": "ShapePolygon", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the generated metadata stream should contain shape information as polygon." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the metadata stream." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ProfileExtension", + "type_name": "ProfileExtension", + "definition": { + "kind": "complexType", + "name": "ProfileExtension", + "fields": [ + { + "name": "AudioOutputConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfiguration", + "type_name": "AudioOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio output." + }, + { + "name": "SendPrimacy", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\t\t\tneeds to be switched.\n\t\t\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio output." + }, + { + "name": "AudioDecoderConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfiguration", + "type_name": "AudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfiguration", + "description": "The Audio Decoder Configuration does not contain any that parameter to configure the\ndecoding .A decoder shall decode every data it receives (according to its capabilities).", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio decoder." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ProfileExtension2", + "type_name": "ProfileExtension2", + "definition": { + "kind": "complexType", + "name": "ProfileExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Extensions defined in ONVIF 2.0" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of the profile." + }, + { + "use": "optional", + "name": "fixed", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true signals that the profile cannot be deleted. Default is false." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "lists all profiles that exist in the media service" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "AddVideoEncoderConfiguration", + "port_type": "Media", + "description": "This operation adds a VideoEncoderConfiguration to an existing media profile. If a configuration exists in the media profile, it will be replaced. The change shall be persistent. A device shall support adding a compatible VideoEncoderConfiguration to a Profile containing a VideoSourceConfiguration and shall support streaming video data of such a profile.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddVideoEncoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddVideoEncoderConfiguration", + "schema": { + "name": "AddVideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the profile where the configuration should be added" + }, + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the VideoEncoderConfiguration to add" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddVideoEncoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddVideoEncoderConfigurationResponse", + "schema": { + "name": "AddVideoEncoderConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "RemoveVideoEncoderConfiguration", + "port_type": "Media", + "description": "This operation removes a VideoEncoderConfiguration from an existing media profile. If the media profile does not contain a VideoEncoderConfiguration, the operation has no effect. The removal shall be persistent.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveVideoEncoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveVideoEncoderConfiguration", + "schema": { + "name": "RemoveVideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the media profile from which the\nVideoEncoderConfiguration shall be removed." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveVideoEncoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveVideoEncoderConfigurationResponse", + "schema": { + "name": "RemoveVideoEncoderConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "AddVideoSourceConfiguration", + "port_type": "Media", + "description": "This operation adds a VideoSourceConfiguration to an existing media profile. If such a configuration exists in the media profile, it will be replaced. The change shall be persistent.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddVideoSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddVideoSourceConfiguration", + "schema": { + "name": "AddVideoSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the profile where the configuration should be added" + }, + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the VideoSourceConfiguration to add" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddVideoSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddVideoSourceConfigurationResponse", + "schema": { + "name": "AddVideoSourceConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "RemoveVideoSourceConfiguration", + "port_type": "Media", + "description": "This operation removes a VideoSourceConfiguration from an existing media profile. If the media profile does not contain a VideoSourceConfiguration, the operation has no effect. The removal shall be persistent. Video source configurations should only be removed after removing a VideoEncoderConfiguration from the media profile.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveVideoSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveVideoSourceConfiguration", + "schema": { + "name": "RemoveVideoSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the media profile from which the\nVideoSourceConfiguration shall be removed." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveVideoSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveVideoSourceConfigurationResponse", + "schema": { + "name": "RemoveVideoSourceConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "AddAudioEncoderConfiguration", + "port_type": "Media", + "description": "This operation adds an AudioEncoderConfiguration to an existing media profile. If a configuration exists in the media profile, it will be replaced. The change shall be persistent. A device shall support adding a compatible AudioEncoderConfiguration to a profile containing an AudioSourceConfiguration and shall support streaming audio data of such a profile.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddAudioEncoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddAudioEncoderConfiguration", + "schema": { + "name": "AddAudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the profile where the configuration should be added" + }, + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the AudioEncoderConfiguration to add" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddAudioEncoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddAudioEncoderConfigurationResponse", + "schema": { + "name": "AddAudioEncoderConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "RemoveAudioEncoderConfiguration", + "port_type": "Media", + "description": "This operation removes an AudioEncoderConfiguration from an existing media profile. If the media profile does not contain an AudioEncoderConfiguration, the operation has no effect. The removal shall be persistent.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioEncoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioEncoderConfiguration", + "schema": { + "name": "RemoveAudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the media profile from which the\nAudioEncoderConfiguration shall be removed." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioEncoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioEncoderConfigurationResponse", + "schema": { + "name": "RemoveAudioEncoderConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "AddAudioSourceConfiguration", + "port_type": "Media", + "description": "This operation adds an AudioSourceConfiguration to an existing media profile. If a configuration exists in the media profile, it will be replaced. The change shall be persistent.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddAudioSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddAudioSourceConfiguration", + "schema": { + "name": "AddAudioSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the profile where the configuration should be added" + }, + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the AudioSourceConfiguration to add" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddAudioSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddAudioSourceConfigurationResponse", + "schema": { + "name": "AddAudioSourceConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "RemoveAudioSourceConfiguration", + "port_type": "Media", + "description": "This operation removes an AudioSourceConfiguration from an existing media profile. If the media profile does not contain an AudioSourceConfiguration, the operation has no effect. The removal shall be persistent. Audio source configurations should only be removed after removing an AudioEncoderConfiguration from the media profile.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioSourceConfiguration", + "schema": { + "name": "RemoveAudioSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the media profile from which the\nAudioSourceConfiguration shall be removed." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioSourceConfigurationResponse", + "schema": { + "name": "RemoveAudioSourceConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "AddPTZConfiguration", + "port_type": "Media", + "description": "This operation adds a PTZConfiguration to an existing media profile. If a configuration exists in the media profile, it will be replaced. The change shall be persistent. Adding a PTZConfiguration to a media profile means that streams using that media profile can contain PTZ status (in the metadata), and that the media profile can be used for controlling PTZ movement.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddPTZConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddPTZConfiguration", + "schema": { + "name": "AddPTZConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the profile where the configuration should be added" + }, + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the PTZConfiguration to add" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddPTZConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddPTZConfigurationResponse", + "schema": { + "name": "AddPTZConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "RemovePTZConfiguration", + "port_type": "Media", + "description": "This operation removes a PTZConfiguration from an existing media profile. If the media profile does not contain a PTZConfiguration, the operation has no effect. The removal shall be persistent.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemovePTZConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemovePTZConfiguration", + "schema": { + "name": "RemovePTZConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the media profile from which the\nPTZConfiguration shall be removed." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemovePTZConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemovePTZConfigurationResponse", + "schema": { + "name": "RemovePTZConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "AddVideoAnalyticsConfiguration", + "port_type": "Media", + "description": "This operation adds a VideoAnalytics configuration to an existing media profile. If a configuration exists in the media profile, it will be replaced. The change shall be persistent. Adding a VideoAnalyticsConfiguration to a media profile means that streams using that media profile can contain video analytics data (in the metadata) as defined by the submitted configuration reference. A profile containing only a video analytics configuration but no video source configuration is incomplete. Therefore, a client should first add a video source configuration to a profile before adding a video analytics configuration. The device can deny adding of a video analytics configuration before a video source configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddVideoAnalyticsConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddVideoAnalyticsConfiguration", + "schema": { + "name": "AddVideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the profile where the configuration should be added" + }, + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the VideoAnalyticsConfiguration to add" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddVideoAnalyticsConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddVideoAnalyticsConfigurationResponse", + "schema": { + "name": "AddVideoAnalyticsConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "RemoveVideoAnalyticsConfiguration", + "port_type": "Media", + "description": "This operation removes a VideoAnalyticsConfiguration from an existing media profile. If the media profile does not contain a VideoAnalyticsConfiguration, the operation has no effect. The removal shall be persistent.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveVideoAnalyticsConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveVideoAnalyticsConfiguration", + "schema": { + "name": "RemoveVideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the media profile from which the\nVideoAnalyticsConfiguration shall be removed." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveVideoAnalyticsConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveVideoAnalyticsConfigurationResponse", + "schema": { + "name": "RemoveVideoAnalyticsConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "AddMetadataConfiguration", + "port_type": "Media", + "description": "This operation adds a Metadata configuration to an existing media profile. If a configuration exists in the media profile, it will be replaced. The change shall be persistent. Adding a MetadataConfiguration to a Profile means that streams using that profile contain metadata. Metadata can consist of events, PTZ status, and/or video analytics data.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddMetadataConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddMetadataConfiguration", + "schema": { + "name": "AddMetadataConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the profile where the configuration should be added" + }, + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the MetadataConfiguration to add" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddMetadataConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddMetadataConfigurationResponse", + "schema": { + "name": "AddMetadataConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "RemoveMetadataConfiguration", + "port_type": "Media", + "description": "This operation removes a MetadataConfiguration from an existing media profile. If the media profile does not contain a MetadataConfiguration, the operation has no effect. The removal shall be persistent.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveMetadataConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveMetadataConfiguration", + "schema": { + "name": "RemoveMetadataConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the media profile from which the\nMetadataConfiguration shall be removed." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveMetadataConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveMetadataConfigurationResponse", + "schema": { + "name": "RemoveMetadataConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "AddAudioOutputConfiguration", + "port_type": "Media", + "description": "This operation adds an AudioOutputConfiguration to an existing media profile. If a configuration exists in the media profile, it will be replaced. The change shall be persistent.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddAudioOutputConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddAudioOutputConfiguration", + "schema": { + "name": "AddAudioOutputConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the profile where the configuration should be added" + }, + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the AudioOutputConfiguration to add" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddAudioOutputConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddAudioOutputConfigurationResponse", + "schema": { + "name": "AddAudioOutputConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "RemoveAudioOutputConfiguration", + "port_type": "Media", + "description": "This operation removes an AudioOutputConfiguration from an existing media profile. If the media profile does not contain an AudioOutputConfiguration, the operation has no effect. The removal shall be persistent.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioOutputConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioOutputConfiguration", + "schema": { + "name": "RemoveAudioOutputConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a reference to the media profile from which the\nAudioOutputConfiguration shall be removed." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioOutputConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioOutputConfigurationResponse", + "schema": { + "name": "RemoveAudioOutputConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "AddAudioDecoderConfiguration", + "port_type": "Media", + "description": "This operation adds an AudioDecoderConfiguration to an existing media profile. If a configuration exists in the media profile, it shall be replaced. The change shall be persistent.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddAudioDecoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddAudioDecoderConfiguration", + "schema": { + "name": "AddAudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This element contains a reference to the profile where the configuration should be added." + }, + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This element contains a reference to the AudioDecoderConfiguration to add." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}AddAudioDecoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}AddAudioDecoderConfigurationResponse", + "schema": { + "name": "AddAudioDecoderConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "RemoveAudioDecoderConfiguration", + "port_type": "Media", + "description": "This operation removes an AudioDecoderConfiguration from an existing media profile. If the media profile does not contain an AudioDecoderConfiguration, the operation has no effect. The removal shall be persistent.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioDecoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioDecoderConfiguration", + "schema": { + "name": "RemoveAudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This element contains a reference to the media profile from which the AudioDecoderConfiguration shall be removed." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioDecoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}RemoveAudioDecoderConfigurationResponse", + "schema": { + "name": "RemoveAudioDecoderConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "DeleteProfile", + "port_type": "Media", + "description": "This operation deletes a profile. This change shall always be persistent. Deletion of a profile is only possible for non-fixed profiles", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}DeleteProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}DeleteProfile", + "schema": { + "name": "DeleteProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This element contains a reference to the profile that should be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}DeleteProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}DeleteProfileResponse", + "schema": { + "name": "DeleteProfileResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetVideoSourceConfigurations", + "port_type": "Media", + "description": "This operation lists all existing video source configurations for a device. The client need not know anything about the video source configurations in order to use the command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceConfigurations", + "schema": { + "name": "GetVideoSourceConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceConfigurationsResponse", + "schema": { + "name": "GetVideoSourceConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfiguration", + "type_name": "VideoSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the physical input." + }, + { + "name": "Bounds", + "type": "{http://www.onvif.org/ver10/schema}IntRectangle", + "type_name": "IntRectangle", + "definition": { + "kind": "complexType", + "name": "IntRectangle", + "description": "Rectangle defined by lower left corner position and size. Units are pixel.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "width", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "height", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension", + "type_name": "VideoSourceConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}Rotate", + "type_name": "Rotate", + "definition": { + "kind": "complexType", + "name": "Rotate", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Rotation feature." + }, + { + "name": "Degree", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateExtension", + "type_name": "RotateExtension", + "definition": { + "kind": "complexType", + "name": "RotateExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
\n\t\t\t\twhen Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rotation of captured image.\n\t\t\t\t\t\tWhat resolutions a device supports shall be unaffected by the Rotate parameters.
\n\t\t\t\t\t\tIf a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
\n\t\t\t\t\t\tThe device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition:\n\t\t\t\t\t\tif Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension2", + "type_name": "VideoSourceConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension2", + "fields": [ + { + "name": "LensDescription", + "type": "{http://www.onvif.org/ver10/schema}LensDescription", + "type_name": "LensDescription", + "definition": { + "kind": "complexType", + "name": "LensDescription", + "fields": [ + { + "name": "Offset", + "type": "{http://www.onvif.org/ver10/schema}LensOffset", + "type_name": "LensOffset", + "definition": { + "kind": "complexType", + "name": "LensOffset", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional horizontal offset of the lens center in normalized coordinates." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional vertical offset of the lens center in normalized coordinates." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Offset of the lens center to the imager center in normalized coordinates." + }, + { + "name": "Projection", + "type": "{http://www.onvif.org/ver10/schema}LensProjection", + "type_name": "LensProjection", + "definition": { + "kind": "complexType", + "name": "LensProjection", + "fields": [ + { + "name": "Angle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Angle of incidence." + }, + { + "name": "Radius", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mapping radius as a consequence of the emergent angle." + }, + { + "name": "Transmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ray absorption at the given angle due to vignetting. A value of one means no absorption." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation\n\t\t\t\t\tover the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius.\n\t\t\t\t\tItems outside the last projection Radius shall be assumed to be invisible (black)." + }, + { + "name": "XFactor", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Compensation of the x coordinate needed for the ONVIF normalized coordinate system." + } + ], + "attributes": [ + { + "use": "optional", + "name": "FocalLength", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional focal length of the optical system." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional element describing the geometric lens distortion. Multiple instances for future variable lens support." + }, + { + "name": "SceneOrientation", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientation", + "type_name": "SceneOrientation", + "definition": { + "kind": "complexType", + "name": "SceneOrientation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to assign the way the camera determines the scene orientation." + }, + { + "name": "Orientation", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field\n\t\t\t\t\t\tis optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required\n\t\t\t\t\t\tand the device will return an InvalidArgs fault if missing." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element describing the scene orientation in the camera's field of view." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "ViewMode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of video source configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetVideoEncoderConfigurations", + "port_type": "Media", + "description": "This operation lists all existing video encoder configurations of a device. This command lists all configured video encoder configurations in a device. The client need not know anything apriori about the video encoder configurations in order to use the command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoEncoderConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoEncoderConfigurations", + "schema": { + "name": "GetVideoEncoderConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoEncoderConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoEncoderConfigurationsResponse", + "schema": { + "name": "GetVideoEncoderConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfiguration", + "type_name": "VideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoding", + "type_name": "VideoEncoding", + "definition": { + "kind": "simpleType", + "name": "VideoEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "JPEG" + }, + { + "value": "MPEG4" + }, + { + "value": "H264" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Used video codec, either Jpeg, H.264 or Mpeg4" + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl", + "type_name": "VideoRateControl", + "definition": { + "kind": "complexType", + "name": "VideoRateControl", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor." + }, + { + "name": "EncodingInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)" + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum output bitrate in kbps." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Configuration", + "type_name": "Mpeg4Configuration", + "definition": { + "kind": "complexType", + "name": "Mpeg4Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "Mpeg4Profile", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Mpeg4 related parameters." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Configuration", + "type_name": "H264Configuration", + "definition": { + "kind": "complexType", + "name": "H264Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "H264Profile", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the H.264 profile, either baseline, main, extended or high" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure H.264 related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related video stream" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of video encoder configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioSourceConfigurations", + "port_type": "Media", + "description": "This operation lists all existing audio source configurations of a device. This command lists all audio source configurations in a device. The client need not know anything apriori about the audio source configurations in order to use the command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourceConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourceConfigurations", + "schema": { + "name": "GetAudioSourceConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourceConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourceConfigurationsResponse", + "schema": { + "name": "GetAudioSourceConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfiguration", + "type_name": "AudioSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Audio Source the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of audio source configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioEncoderConfigurations", + "port_type": "Media", + "description": "This operation lists all existing device audio encoder configurations. The client need not know anything apriori about the audio encoder configurations in order to use the command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioEncoderConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioEncoderConfigurations", + "schema": { + "name": "GetAudioEncoderConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioEncoderConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioEncoderConfigurationsResponse", + "schema": { + "name": "GetAudioEncoderConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of audio encoder configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetVideoAnalyticsConfigurations", + "port_type": "Media", + "description": "This operation lists all video analytics configurations of a device. This command lists all configured video analytics in a device. The client need not know anything apriori about the video analytics in order to use the command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoAnalyticsConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoAnalyticsConfigurations", + "schema": { + "name": "GetVideoAnalyticsConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoAnalyticsConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoAnalyticsConfigurationsResponse", + "schema": { + "name": "GetVideoAnalyticsConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}VideoAnalyticsConfiguration", + "type_name": "VideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoAnalyticsConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfiguration", + "type_name": "RuleEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfiguration", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfigurationExtension", + "type_name": "RuleEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of VideoAnalytics configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetMetadataConfigurations", + "port_type": "Media", + "description": "This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetMetadataConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetMetadataConfigurations", + "schema": { + "name": "GetMetadataConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetMetadataConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetMetadataConfigurationsResponse", + "schema": { + "name": "GetMetadataConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfiguration", + "type_name": "MetadataConfiguration", + "definition": { + "kind": "complexType", + "name": "MetadataConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "PTZStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZFilter", + "type_name": "PTZFilter", + "definition": { + "kind": "complexType", + "name": "PTZFilter", + "fields": [ + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN)." + }, + { + "name": "Position", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ position." + }, + { + "name": "FieldOfView", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the field-of-view information." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which PTZ related data is to include in the metadata stream." + }, + { + "name": "Events", + "type": "{http://www.onvif.org/ver10/schema}EventSubscription", + "type_name": "EventSubscription", + "definition": { + "kind": "complexType", + "name": "EventSubscription", + "description": "Subscription handling in the same way as base notification subscription.", + "fields": [ + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure the streaming of events. A client might be interested in receiving all,\n\t\t\t\t\t\t\t\tnone or some of the events produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all events: Include the Events element but do not include a filter.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no events: Do not include the Events element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some events: Include the Events element and include a filter in the element.
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Analytics", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)" + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored)" + }, + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indication which AnalyticsModules shall output metadata.\n\t\t\t\t\t\t\tNote that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration." + }, + { + "name": "SensorData", + "type": "{http://www.onvif.org/ver10/schema}SensorDataFilter", + "type_name": "SensorDataFilter", + "definition": { + "kind": "complexType", + "name": "SensorDataFilter", + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:\n\t\t\t\t
    \n\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t
", + "fields": [ + { + "name": "SensorID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them)." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, \n\t\t\t\t\t\t\t\tnone or some of the sensor data produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationExtension", + "type_name": "MetadataConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "CompressionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType." + }, + { + "use": "optional", + "name": "GeoLocation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target." + }, + { + "use": "optional", + "name": "ShapePolygon", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the generated metadata stream should contain shape information as polygon." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of metadata configurations" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioOutputConfigurations", + "port_type": "Media", + "description": "This command lists all existing AudioOutputConfigurations of a device. The NVC need not know anything apriori about the audio configurations to use this command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputConfigurations", + "schema": { + "name": "GetAudioOutputConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputConfigurationsResponse", + "schema": { + "name": "GetAudioOutputConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfiguration", + "type_name": "AudioOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio output." + }, + { + "name": "SendPrimacy", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\t\t\tneeds to be switched.\n\t\t\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of audio output configurations" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioDecoderConfigurations", + "port_type": "Media", + "description": "This command lists all existing AudioDecoderConfigurations of a device. The NVC need not know anything apriori about the audio decoder configurations in order to use this command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioDecoderConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioDecoderConfigurations", + "schema": { + "name": "GetAudioDecoderConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioDecoderConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioDecoderConfigurationsResponse", + "schema": { + "name": "GetAudioDecoderConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfiguration", + "type_name": "AudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfiguration", + "description": "The Audio Decoder Configuration does not contain any that parameter to configure the\ndecoding .A decoder shall decode every data it receives (according to its capabilities).", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of audio decoder configurations" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetVideoSourceConfiguration", + "port_type": "Media", + "description": "If the video source configuration token is already known, the video source configuration can be fetched through the GetVideoSourceConfiguration command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceConfiguration", + "schema": { + "name": "GetVideoSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested video source configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceConfigurationResponse", + "schema": { + "name": "GetVideoSourceConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfiguration", + "type_name": "VideoSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the physical input." + }, + { + "name": "Bounds", + "type": "{http://www.onvif.org/ver10/schema}IntRectangle", + "type_name": "IntRectangle", + "definition": { + "kind": "complexType", + "name": "IntRectangle", + "description": "Rectangle defined by lower left corner position and size. Units are pixel.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "width", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "height", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension", + "type_name": "VideoSourceConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}Rotate", + "type_name": "Rotate", + "definition": { + "kind": "complexType", + "name": "Rotate", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Rotation feature." + }, + { + "name": "Degree", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateExtension", + "type_name": "RotateExtension", + "definition": { + "kind": "complexType", + "name": "RotateExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
\n\t\t\t\twhen Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rotation of captured image.\n\t\t\t\t\t\tWhat resolutions a device supports shall be unaffected by the Rotate parameters.
\n\t\t\t\t\t\tIf a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
\n\t\t\t\t\t\tThe device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition:\n\t\t\t\t\t\tif Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension2", + "type_name": "VideoSourceConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension2", + "fields": [ + { + "name": "LensDescription", + "type": "{http://www.onvif.org/ver10/schema}LensDescription", + "type_name": "LensDescription", + "definition": { + "kind": "complexType", + "name": "LensDescription", + "fields": [ + { + "name": "Offset", + "type": "{http://www.onvif.org/ver10/schema}LensOffset", + "type_name": "LensOffset", + "definition": { + "kind": "complexType", + "name": "LensOffset", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional horizontal offset of the lens center in normalized coordinates." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional vertical offset of the lens center in normalized coordinates." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Offset of the lens center to the imager center in normalized coordinates." + }, + { + "name": "Projection", + "type": "{http://www.onvif.org/ver10/schema}LensProjection", + "type_name": "LensProjection", + "definition": { + "kind": "complexType", + "name": "LensProjection", + "fields": [ + { + "name": "Angle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Angle of incidence." + }, + { + "name": "Radius", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mapping radius as a consequence of the emergent angle." + }, + { + "name": "Transmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ray absorption at the given angle due to vignetting. A value of one means no absorption." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation\n\t\t\t\t\tover the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius.\n\t\t\t\t\tItems outside the last projection Radius shall be assumed to be invisible (black)." + }, + { + "name": "XFactor", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Compensation of the x coordinate needed for the ONVIF normalized coordinate system." + } + ], + "attributes": [ + { + "use": "optional", + "name": "FocalLength", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional focal length of the optical system." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional element describing the geometric lens distortion. Multiple instances for future variable lens support." + }, + { + "name": "SceneOrientation", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientation", + "type_name": "SceneOrientation", + "definition": { + "kind": "complexType", + "name": "SceneOrientation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to assign the way the camera determines the scene orientation." + }, + { + "name": "Orientation", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field\n\t\t\t\t\t\tis optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required\n\t\t\t\t\t\tand the device will return an InvalidArgs fault if missing." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element describing the scene orientation in the camera's field of view." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "ViewMode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested video source configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetVideoEncoderConfiguration", + "port_type": "Media", + "description": "If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoEncoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoEncoderConfiguration", + "schema": { + "name": "GetVideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested video encoder configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoEncoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoEncoderConfigurationResponse", + "schema": { + "name": "GetVideoEncoderConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfiguration", + "type_name": "VideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoding", + "type_name": "VideoEncoding", + "definition": { + "kind": "simpleType", + "name": "VideoEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "JPEG" + }, + { + "value": "MPEG4" + }, + { + "value": "H264" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Used video codec, either Jpeg, H.264 or Mpeg4" + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl", + "type_name": "VideoRateControl", + "definition": { + "kind": "complexType", + "name": "VideoRateControl", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor." + }, + { + "name": "EncodingInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)" + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum output bitrate in kbps." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Configuration", + "type_name": "Mpeg4Configuration", + "definition": { + "kind": "complexType", + "name": "Mpeg4Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "Mpeg4Profile", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Mpeg4 related parameters." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Configuration", + "type_name": "H264Configuration", + "definition": { + "kind": "complexType", + "name": "H264Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "H264Profile", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the H.264 profile, either baseline, main, extended or high" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure H.264 related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related video stream" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested video encoder configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioSourceConfiguration", + "port_type": "Media", + "description": "The GetAudioSourceConfiguration command fetches the audio source configurations if the audio source configuration token is already known. An", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourceConfiguration", + "schema": { + "name": "GetAudioSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested audio source configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourceConfigurationResponse", + "schema": { + "name": "GetAudioSourceConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfiguration", + "type_name": "AudioSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Audio Source the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested audio source configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioEncoderConfiguration", + "port_type": "Media", + "description": "The GetAudioEncoderConfiguration command fetches the encoder configuration if the audio encoder configuration token is known.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioEncoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioEncoderConfiguration", + "schema": { + "name": "GetAudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested audio encoder configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioEncoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioEncoderConfigurationResponse", + "schema": { + "name": "GetAudioEncoderConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested audio encoder configuration" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetVideoAnalyticsConfiguration", + "port_type": "Media", + "description": "The GetVideoAnalyticsConfiguration command fetches the video analytics configuration if the video analytics token is known.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoAnalyticsConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoAnalyticsConfiguration", + "schema": { + "name": "GetVideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested video analytics configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoAnalyticsConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoAnalyticsConfigurationResponse", + "schema": { + "name": "GetVideoAnalyticsConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}VideoAnalyticsConfiguration", + "type_name": "VideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoAnalyticsConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfiguration", + "type_name": "RuleEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfiguration", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfigurationExtension", + "type_name": "RuleEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested video analytics configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetMetadataConfiguration", + "port_type": "Media", + "description": "The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetMetadataConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetMetadataConfiguration", + "schema": { + "name": "GetMetadataConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested metadata configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetMetadataConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetMetadataConfigurationResponse", + "schema": { + "name": "GetMetadataConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfiguration", + "type_name": "MetadataConfiguration", + "definition": { + "kind": "complexType", + "name": "MetadataConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "PTZStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZFilter", + "type_name": "PTZFilter", + "definition": { + "kind": "complexType", + "name": "PTZFilter", + "fields": [ + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN)." + }, + { + "name": "Position", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ position." + }, + { + "name": "FieldOfView", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the field-of-view information." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which PTZ related data is to include in the metadata stream." + }, + { + "name": "Events", + "type": "{http://www.onvif.org/ver10/schema}EventSubscription", + "type_name": "EventSubscription", + "definition": { + "kind": "complexType", + "name": "EventSubscription", + "description": "Subscription handling in the same way as base notification subscription.", + "fields": [ + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure the streaming of events. A client might be interested in receiving all,\n\t\t\t\t\t\t\t\tnone or some of the events produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all events: Include the Events element but do not include a filter.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no events: Do not include the Events element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some events: Include the Events element and include a filter in the element.
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Analytics", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)" + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored)" + }, + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indication which AnalyticsModules shall output metadata.\n\t\t\t\t\t\t\tNote that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration." + }, + { + "name": "SensorData", + "type": "{http://www.onvif.org/ver10/schema}SensorDataFilter", + "type_name": "SensorDataFilter", + "definition": { + "kind": "complexType", + "name": "SensorDataFilter", + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:\n\t\t\t\t
    \n\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t
", + "fields": [ + { + "name": "SensorID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them)." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, \n\t\t\t\t\t\t\t\tnone or some of the sensor data produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationExtension", + "type_name": "MetadataConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "CompressionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType." + }, + { + "use": "optional", + "name": "GeoLocation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target." + }, + { + "use": "optional", + "name": "ShapePolygon", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the generated metadata stream should contain shape information as polygon." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested metadata configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioOutputConfiguration", + "port_type": "Media", + "description": "If the audio output configuration token is already known, the output configuration can be fetched through the GetAudioOutputConfiguration command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputConfiguration", + "schema": { + "name": "GetAudioOutputConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested audio output configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputConfigurationResponse", + "schema": { + "name": "GetAudioOutputConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfiguration", + "type_name": "AudioOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio output." + }, + { + "name": "SendPrimacy", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\t\t\tneeds to be switched.\n\t\t\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested audio output configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioDecoderConfiguration", + "port_type": "Media", + "description": "If the audio decoder configuration token is already known, the decoder configuration can be fetched through the GetAudioDecoderConfiguration command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioDecoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioDecoderConfiguration", + "schema": { + "name": "GetAudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested audio decoder configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioDecoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioDecoderConfigurationResponse", + "schema": { + "name": "GetAudioDecoderConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfiguration", + "type_name": "AudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfiguration", + "description": "The Audio Decoder Configuration does not contain any that parameter to configure the\ndecoding .A decoder shall decode every data it receives (according to its capabilities).", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested audio decoder configuration" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetCompatibleVideoEncoderConfigurations", + "port_type": "Media", + "description": "This operation lists all the video encoder configurations of the device that are compatible with a certain media profile. Each of the returned configurations shall be a valid input parameter for the AddVideoEncoderConfiguration command on the media profile. The result will vary depending on the capabilities, configurations and settings in the device.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleVideoEncoderConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleVideoEncoderConfigurations", + "schema": { + "name": "GetCompatibleVideoEncoderConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleVideoEncoderConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleVideoEncoderConfigurationsResponse", + "schema": { + "name": "GetCompatibleVideoEncoderConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfiguration", + "type_name": "VideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoding", + "type_name": "VideoEncoding", + "definition": { + "kind": "simpleType", + "name": "VideoEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "JPEG" + }, + { + "value": "MPEG4" + }, + { + "value": "H264" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Used video codec, either Jpeg, H.264 or Mpeg4" + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl", + "type_name": "VideoRateControl", + "definition": { + "kind": "complexType", + "name": "VideoRateControl", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor." + }, + { + "name": "EncodingInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)" + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum output bitrate in kbps." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Configuration", + "type_name": "Mpeg4Configuration", + "definition": { + "kind": "complexType", + "name": "Mpeg4Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "Mpeg4Profile", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Mpeg4 related parameters." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Configuration", + "type_name": "H264Configuration", + "definition": { + "kind": "complexType", + "name": "H264Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "H264Profile", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the H.264 profile, either baseline, main, extended or high" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure H.264 related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related video stream" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of video encoder configurations that are compatible with the specified media profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetCompatibleVideoSourceConfigurations", + "port_type": "Media", + "description": "This operation requests all the video source configurations of the device that are compatible with a certain media profile. Each of the returned configurations shall be a valid input parameter for the AddVideoSourceConfiguration command on the media profile. The result will vary depending on the capabilities, configurations and settings in the device.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleVideoSourceConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleVideoSourceConfigurations", + "schema": { + "name": "GetCompatibleVideoSourceConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleVideoSourceConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleVideoSourceConfigurationsResponse", + "schema": { + "name": "GetCompatibleVideoSourceConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfiguration", + "type_name": "VideoSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the physical input." + }, + { + "name": "Bounds", + "type": "{http://www.onvif.org/ver10/schema}IntRectangle", + "type_name": "IntRectangle", + "definition": { + "kind": "complexType", + "name": "IntRectangle", + "description": "Rectangle defined by lower left corner position and size. Units are pixel.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "width", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "height", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension", + "type_name": "VideoSourceConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}Rotate", + "type_name": "Rotate", + "definition": { + "kind": "complexType", + "name": "Rotate", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Rotation feature." + }, + { + "name": "Degree", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateExtension", + "type_name": "RotateExtension", + "definition": { + "kind": "complexType", + "name": "RotateExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
\n\t\t\t\twhen Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rotation of captured image.\n\t\t\t\t\t\tWhat resolutions a device supports shall be unaffected by the Rotate parameters.
\n\t\t\t\t\t\tIf a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
\n\t\t\t\t\t\tThe device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition:\n\t\t\t\t\t\tif Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension2", + "type_name": "VideoSourceConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension2", + "fields": [ + { + "name": "LensDescription", + "type": "{http://www.onvif.org/ver10/schema}LensDescription", + "type_name": "LensDescription", + "definition": { + "kind": "complexType", + "name": "LensDescription", + "fields": [ + { + "name": "Offset", + "type": "{http://www.onvif.org/ver10/schema}LensOffset", + "type_name": "LensOffset", + "definition": { + "kind": "complexType", + "name": "LensOffset", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional horizontal offset of the lens center in normalized coordinates." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional vertical offset of the lens center in normalized coordinates." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Offset of the lens center to the imager center in normalized coordinates." + }, + { + "name": "Projection", + "type": "{http://www.onvif.org/ver10/schema}LensProjection", + "type_name": "LensProjection", + "definition": { + "kind": "complexType", + "name": "LensProjection", + "fields": [ + { + "name": "Angle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Angle of incidence." + }, + { + "name": "Radius", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mapping radius as a consequence of the emergent angle." + }, + { + "name": "Transmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ray absorption at the given angle due to vignetting. A value of one means no absorption." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation\n\t\t\t\t\tover the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius.\n\t\t\t\t\tItems outside the last projection Radius shall be assumed to be invisible (black)." + }, + { + "name": "XFactor", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Compensation of the x coordinate needed for the ONVIF normalized coordinate system." + } + ], + "attributes": [ + { + "use": "optional", + "name": "FocalLength", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional focal length of the optical system." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional element describing the geometric lens distortion. Multiple instances for future variable lens support." + }, + { + "name": "SceneOrientation", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientation", + "type_name": "SceneOrientation", + "definition": { + "kind": "complexType", + "name": "SceneOrientation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to assign the way the camera determines the scene orientation." + }, + { + "name": "Orientation", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field\n\t\t\t\t\t\tis optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required\n\t\t\t\t\t\tand the device will return an InvalidArgs fault if missing." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element describing the scene orientation in the camera's field of view." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "ViewMode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of video source configurations that are compatible with the specified media profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetCompatibleAudioEncoderConfigurations", + "port_type": "Media", + "description": "This operation requests all audio encoder configurations of a device that are compatible with a certain media profile. Each of the returned configurations shall be a valid input parameter for the AddAudioSourceConfiguration command on the media profile. The result varies depending on the capabilities, configurations and settings in the device.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioEncoderConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioEncoderConfigurations", + "schema": { + "name": "GetCompatibleAudioEncoderConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioEncoderConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioEncoderConfigurationsResponse", + "schema": { + "name": "GetCompatibleAudioEncoderConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of audio encoder configurations that are compatible with the specified media profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetCompatibleAudioSourceConfigurations", + "port_type": "Media", + "description": "This operation requests all audio source configurations of the device that are compatible with a certain media profile. Each of the returned configurations shall be a valid input parameter for the AddAudioEncoderConfiguration command on the media profile. The result varies depending on the capabilities, configurations and settings in the device.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioSourceConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioSourceConfigurations", + "schema": { + "name": "GetCompatibleAudioSourceConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioSourceConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioSourceConfigurationsResponse", + "schema": { + "name": "GetCompatibleAudioSourceConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfiguration", + "type_name": "AudioSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Audio Source the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of audio source configurations that are compatible with the specified media profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetCompatibleVideoAnalyticsConfigurations", + "port_type": "Media", + "description": "This operation requests all video analytic configurations of the device that are compatible with a certain media profile. Each of the returned configurations shall be a valid input parameter for the AddVideoAnalyticsConfiguration command on the media profile. The result varies depending on the capabilities, configurations and settings in the device.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleVideoAnalyticsConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleVideoAnalyticsConfigurations", + "schema": { + "name": "GetCompatibleVideoAnalyticsConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleVideoAnalyticsConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleVideoAnalyticsConfigurationsResponse", + "schema": { + "name": "GetCompatibleVideoAnalyticsConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}VideoAnalyticsConfiguration", + "type_name": "VideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoAnalyticsConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfiguration", + "type_name": "RuleEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfiguration", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfigurationExtension", + "type_name": "RuleEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of video analytics configurations that are compatible with the specified media profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetCompatibleMetadataConfigurations", + "port_type": "Media", + "description": "This operation requests all the metadata configurations of the device that are compatible with a certain media profile. Each of the returned configurations shall be a valid input parameter for the AddMetadataConfiguration command on the media profile. The result varies depending on the capabilities, configurations and settings in the device.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleMetadataConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleMetadataConfigurations", + "schema": { + "name": "GetCompatibleMetadataConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleMetadataConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleMetadataConfigurationsResponse", + "schema": { + "name": "GetCompatibleMetadataConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfiguration", + "type_name": "MetadataConfiguration", + "definition": { + "kind": "complexType", + "name": "MetadataConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "PTZStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZFilter", + "type_name": "PTZFilter", + "definition": { + "kind": "complexType", + "name": "PTZFilter", + "fields": [ + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN)." + }, + { + "name": "Position", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ position." + }, + { + "name": "FieldOfView", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the field-of-view information." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which PTZ related data is to include in the metadata stream." + }, + { + "name": "Events", + "type": "{http://www.onvif.org/ver10/schema}EventSubscription", + "type_name": "EventSubscription", + "definition": { + "kind": "complexType", + "name": "EventSubscription", + "description": "Subscription handling in the same way as base notification subscription.", + "fields": [ + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure the streaming of events. A client might be interested in receiving all,\n\t\t\t\t\t\t\t\tnone or some of the events produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all events: Include the Events element but do not include a filter.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no events: Do not include the Events element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some events: Include the Events element and include a filter in the element.
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Analytics", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)" + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored)" + }, + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indication which AnalyticsModules shall output metadata.\n\t\t\t\t\t\t\tNote that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration." + }, + { + "name": "SensorData", + "type": "{http://www.onvif.org/ver10/schema}SensorDataFilter", + "type_name": "SensorDataFilter", + "definition": { + "kind": "complexType", + "name": "SensorDataFilter", + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:\n\t\t\t\t
    \n\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t
", + "fields": [ + { + "name": "SensorID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them)." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, \n\t\t\t\t\t\t\t\tnone or some of the sensor data produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationExtension", + "type_name": "MetadataConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "CompressionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType." + }, + { + "use": "optional", + "name": "GeoLocation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target." + }, + { + "use": "optional", + "name": "ShapePolygon", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the generated metadata stream should contain shape information as polygon." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of metadata configurations that are compatible with the specified media profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetCompatibleAudioOutputConfigurations", + "port_type": "Media", + "description": "This command lists all audio output configurations of a device that are compatible with a certain media profile. Each returned configuration shall be a valid input for the AddAudioOutputConfiguration command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioOutputConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioOutputConfigurations", + "schema": { + "name": "GetCompatibleAudioOutputConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioOutputConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioOutputConfigurationsResponse", + "schema": { + "name": "GetCompatibleAudioOutputConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfiguration", + "type_name": "AudioOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio output." + }, + { + "name": "SendPrimacy", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\t\t\tneeds to be switched.\n\t\t\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of audio output configurations that are compatible with the specified media profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetCompatibleAudioDecoderConfigurations", + "port_type": "Media", + "description": "This operation lists all the audio decoder configurations of the device that are compatible with a certain media profile. Each of the returned configurations shall be a valid input parameter for the AddAudioDecoderConfiguration command on the media profile.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioDecoderConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioDecoderConfigurations", + "schema": { + "name": "GetCompatibleAudioDecoderConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioDecoderConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetCompatibleAudioDecoderConfigurationsResponse", + "schema": { + "name": "GetCompatibleAudioDecoderConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfiguration", + "type_name": "AudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfiguration", + "description": "The Audio Decoder Configuration does not contain any that parameter to configure the\ndecoding .A decoder shall decode every data it receives (according to its capabilities).", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Contains a list of audio decoder configurations that are compatible with the specified media profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "SetVideoSourceConfiguration", + "port_type": "Media", + "description": "This operation modifies a video source configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream. NVC methods for changing a running stream are out of scope for this specification.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetVideoSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetVideoSourceConfiguration", + "schema": { + "name": "SetVideoSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfiguration", + "type_name": "VideoSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the physical input." + }, + { + "name": "Bounds", + "type": "{http://www.onvif.org/ver10/schema}IntRectangle", + "type_name": "IntRectangle", + "definition": { + "kind": "complexType", + "name": "IntRectangle", + "description": "Rectangle defined by lower left corner position and size. Units are pixel.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "width", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "height", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension", + "type_name": "VideoSourceConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}Rotate", + "type_name": "Rotate", + "definition": { + "kind": "complexType", + "name": "Rotate", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Rotation feature." + }, + { + "name": "Degree", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateExtension", + "type_name": "RotateExtension", + "definition": { + "kind": "complexType", + "name": "RotateExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
\n\t\t\t\twhen Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rotation of captured image.\n\t\t\t\t\t\tWhat resolutions a device supports shall be unaffected by the Rotate parameters.
\n\t\t\t\t\t\tIf a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
\n\t\t\t\t\t\tThe device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition:\n\t\t\t\t\t\tif Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension2", + "type_name": "VideoSourceConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension2", + "fields": [ + { + "name": "LensDescription", + "type": "{http://www.onvif.org/ver10/schema}LensDescription", + "type_name": "LensDescription", + "definition": { + "kind": "complexType", + "name": "LensDescription", + "fields": [ + { + "name": "Offset", + "type": "{http://www.onvif.org/ver10/schema}LensOffset", + "type_name": "LensOffset", + "definition": { + "kind": "complexType", + "name": "LensOffset", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional horizontal offset of the lens center in normalized coordinates." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional vertical offset of the lens center in normalized coordinates." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Offset of the lens center to the imager center in normalized coordinates." + }, + { + "name": "Projection", + "type": "{http://www.onvif.org/ver10/schema}LensProjection", + "type_name": "LensProjection", + "definition": { + "kind": "complexType", + "name": "LensProjection", + "fields": [ + { + "name": "Angle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Angle of incidence." + }, + { + "name": "Radius", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mapping radius as a consequence of the emergent angle." + }, + { + "name": "Transmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ray absorption at the given angle due to vignetting. A value of one means no absorption." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation\n\t\t\t\t\tover the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius.\n\t\t\t\t\tItems outside the last projection Radius shall be assumed to be invisible (black)." + }, + { + "name": "XFactor", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Compensation of the x coordinate needed for the ONVIF normalized coordinate system." + } + ], + "attributes": [ + { + "use": "optional", + "name": "FocalLength", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional focal length of the optical system." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional element describing the geometric lens distortion. Multiple instances for future variable lens support." + }, + { + "name": "SceneOrientation", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientation", + "type_name": "SceneOrientation", + "definition": { + "kind": "complexType", + "name": "SceneOrientation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to assign the way the camera determines the scene orientation." + }, + { + "name": "Orientation", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field\n\t\t\t\t\t\tis optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required\n\t\t\t\t\t\tand the device will return an InvalidArgs fault if missing." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element describing the scene orientation in the camera's field of view." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "ViewMode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified video source configuration. The configuration shall exist in the device." + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ForcePersistence element is obsolete and should always be assumed to be true." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetVideoSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetVideoSourceConfigurationResponse", + "schema": { + "name": "SetVideoSourceConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "SetVideoEncoderConfiguration", + "port_type": "Media", + "description": "This operation modifies a video encoder configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Changes in the Multicast settings shall always be persistent. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream. NVC methods for changing a running stream are out of scope for this specification. SessionTimeout is provided as a hint for keeping rtsp session by a device. If necessary the device may adapt parameter values for SessionTimeout elements without returning an error. For the time between keep alive calls the client shall adhere to the timeout value signaled via RTSP.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetVideoEncoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetVideoEncoderConfiguration", + "schema": { + "name": "SetVideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfiguration", + "type_name": "VideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoding", + "type_name": "VideoEncoding", + "definition": { + "kind": "simpleType", + "name": "VideoEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "JPEG" + }, + { + "value": "MPEG4" + }, + { + "value": "H264" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Used video codec, either Jpeg, H.264 or Mpeg4" + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl", + "type_name": "VideoRateControl", + "definition": { + "kind": "complexType", + "name": "VideoRateControl", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor." + }, + { + "name": "EncodingInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)" + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum output bitrate in kbps." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Configuration", + "type_name": "Mpeg4Configuration", + "definition": { + "kind": "complexType", + "name": "Mpeg4Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "Mpeg4Profile", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Mpeg4 related parameters." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Configuration", + "type_name": "H264Configuration", + "definition": { + "kind": "complexType", + "name": "H264Configuration", + "fields": [ + { + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "name": "H264Profile", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the H.264 profile, either baseline, main, extended or high" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure H.264 related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related video stream" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified video encoder configuration. The configuration shall exist in the device." + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ForcePersistence element is obsolete and should always be assumed to be true." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetVideoEncoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetVideoEncoderConfigurationResponse", + "schema": { + "name": "SetVideoEncoderConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "SetAudioSourceConfiguration", + "port_type": "Media", + "description": "This operation modifies an audio source configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream NVC methods for changing a running stream are out of scope for this specification.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetAudioSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetAudioSourceConfiguration", + "schema": { + "name": "SetAudioSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfiguration", + "type_name": "AudioSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Audio Source the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified audio source configuration. The configuration shall exist in the device." + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ForcePersistence element is obsolete and should always be assumed to be true." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetAudioSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetAudioSourceConfigurationResponse", + "schema": { + "name": "SetAudioSourceConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "SetAudioEncoderConfiguration", + "port_type": "Media", + "description": "This operation modifies an audio encoder configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected streams. NVC methods for changing a running stream are out of scope for this specification.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetAudioEncoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetAudioEncoderConfiguration", + "schema": { + "name": "SetAudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfiguration", + "type_name": "AudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio codec used for encoding the audio input (either G.711, G.726 or AAC)." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified audio encoder configuration. The configuration shall exist in the device." + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ForcePersistence element is obsolete and should always be assumed to be true." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetAudioEncoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetAudioEncoderConfigurationResponse", + "schema": { + "name": "SetAudioEncoderConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "SetVideoAnalyticsConfiguration", + "port_type": "Media", + "description": "A video analytics configuration is modified using this command. The ForcePersistence flag indicates if the changes shall remain after reboot of the device or not. Running streams using this configuration shall be immediately updated according to the new settings. Otherwise inconsistencies can occur between the scene description processed by the rule engine and the notifications produced by analytics engine and rule engine which reference the very same video analytics configuration token.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetVideoAnalyticsConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetVideoAnalyticsConfiguration", + "schema": { + "name": "SetVideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}VideoAnalyticsConfiguration", + "type_name": "VideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoAnalyticsConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfiguration", + "type_name": "RuleEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfiguration", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfigurationExtension", + "type_name": "RuleEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified video analytics configuration. The configuration shall exist in the device." + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ForcePersistence element is obsolete and should always be assumed to be true." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetVideoAnalyticsConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetVideoAnalyticsConfigurationResponse", + "schema": { + "name": "SetVideoAnalyticsConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "SetMetadataConfiguration", + "port_type": "Media", + "description": "This operation modifies a metadata configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Changes in the Multicast settings shall always be persistent. Running streams using this configuration may be updated immediately according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected streams. NVC methods for changing a running stream are out of scope for this specification.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetMetadataConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetMetadataConfiguration", + "schema": { + "name": "SetMetadataConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfiguration", + "type_name": "MetadataConfiguration", + "definition": { + "kind": "complexType", + "name": "MetadataConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "PTZStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZFilter", + "type_name": "PTZFilter", + "definition": { + "kind": "complexType", + "name": "PTZFilter", + "fields": [ + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN)." + }, + { + "name": "Position", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ position." + }, + { + "name": "FieldOfView", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the field-of-view information." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which PTZ related data is to include in the metadata stream." + }, + { + "name": "Events", + "type": "{http://www.onvif.org/ver10/schema}EventSubscription", + "type_name": "EventSubscription", + "definition": { + "kind": "complexType", + "name": "EventSubscription", + "description": "Subscription handling in the same way as base notification subscription.", + "fields": [ + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure the streaming of events. A client might be interested in receiving all,\n\t\t\t\t\t\t\t\tnone or some of the events produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all events: Include the Events element but do not include a filter.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no events: Do not include the Events element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some events: Include the Events element and include a filter in the element.
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Analytics", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)" + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored)" + }, + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indication which AnalyticsModules shall output metadata.\n\t\t\t\t\t\t\tNote that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration." + }, + { + "name": "SensorData", + "type": "{http://www.onvif.org/ver10/schema}SensorDataFilter", + "type_name": "SensorDataFilter", + "definition": { + "kind": "complexType", + "name": "SensorDataFilter", + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:\n\t\t\t\t
    \n\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t
", + "fields": [ + { + "name": "SensorID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them)." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, \n\t\t\t\t\t\t\t\tnone or some of the sensor data produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationExtension", + "type_name": "MetadataConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "CompressionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType." + }, + { + "use": "optional", + "name": "GeoLocation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target." + }, + { + "use": "optional", + "name": "ShapePolygon", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the generated metadata stream should contain shape information as polygon." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified metadata configuration. The configuration shall exist in the device." + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ForcePersistence element is obsolete and should always be assumed to be true." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetMetadataConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetMetadataConfigurationResponse", + "schema": { + "name": "SetMetadataConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "SetAudioOutputConfiguration", + "port_type": "Media", + "description": "This operation modifies an audio output configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetAudioOutputConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetAudioOutputConfiguration", + "schema": { + "name": "SetAudioOutputConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfiguration", + "type_name": "AudioOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio output." + }, + { + "name": "SendPrimacy", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\t\t\tneeds to be switched.\n\t\t\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified audio output configuration. The configuration shall exist in the device." + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ForcePersistence element is obsolete and should always be assumed to be true." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetAudioOutputConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetAudioOutputConfigurationResponse", + "schema": { + "name": "SetAudioOutputConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "SetAudioDecoderConfiguration", + "port_type": "Media", + "description": "This operation modifies an audio decoder configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetAudioDecoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetAudioDecoderConfiguration", + "schema": { + "name": "SetAudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfiguration", + "type_name": "AudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfiguration", + "description": "The Audio Decoder Configuration does not contain any that parameter to configure the\ndecoding .A decoder shall decode every data it receives (according to its capabilities).", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified audio decoder configuration. The configuration shall exist in the device." + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ForcePersistence element is obsolete and should always be assumed to be true." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetAudioDecoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetAudioDecoderConfigurationResponse", + "schema": { + "name": "SetAudioDecoderConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetVideoSourceConfigurationOptions", + "port_type": "Media", + "description": "This operation returns the available options (supported values and ranges for video source configuration parameters) when the video source parameters are reconfigured If a video source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceConfigurationOptions", + "schema": { + "name": "GetVideoSourceConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional video source configurationToken that specifies an existing configuration that the options are intended for." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ProfileToken that specifies an existing media profile that the options shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceConfigurationOptionsResponse", + "schema": { + "name": "GetVideoSourceConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationOptions", + "type_name": "VideoSourceConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationOptions", + "fields": [ + { + "name": "BoundsRange", + "type": "{http://www.onvif.org/ver10/schema}IntRectangleRange", + "type_name": "IntRectangleRange", + "definition": { + "kind": "complexType", + "name": "IntRectangleRange", + "description": "Range of a rectangle. The rectangle itself is defined by lower left corner position and size. Units are pixel.", + "fields": [ + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of X-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of Y-axis." + }, + { + "name": "WidthRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of width." + }, + { + "name": "HeightRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of height." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported range for the capturing area.\n\t\t\t\t\t\tDevice that does not support cropped streaming shall express BoundsRange option as mentioned below\n\t\t\t\t\t\tBoundsRange->XRange and BoundsRange->YRange with same Min/Max values HeightRange and WidthRange Min/Max values same as VideoSource Height and Width Limits." + }, + { + "name": "VideoSourceTokensAvailable", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of physical inputs." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationOptionsExtension", + "type_name": "VideoSourceConfigurationOptionsExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationOptionsExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}RotateOptions", + "type_name": "RotateOptions", + "definition": { + "kind": "complexType", + "name": "RotateOptions", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Supported options of Rotate mode parameter." + }, + { + "name": "DegreeList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported degree value for rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateOptionsExtension", + "type_name": "RotateOptionsExtension", + "definition": { + "kind": "complexType", + "name": "RotateOptionsExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Reboot", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Signals if a device requires a reboot after changing the rotation or mirror.\n\t\t\t\tIf a device can handle rotation changes or mirror changes without rebooting this value shall be set to false." + }, + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Signals if video source mirroring is supported." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Options of parameters for Rotation feature." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationOptionsExtension2", + "type_name": "VideoSourceConfigurationOptionsExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationOptionsExtension2", + "fields": [ + { + "name": "SceneOrientationMode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Scene orientation modes supported by the device for this configuration." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "MaximumNumberOfProfiles", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of profiles." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This message contains the video source configuration options. If a video source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetVideoEncoderConfigurationOptions", + "port_type": "Media", + "description": "This operation returns the available options (supported values and ranges for video encoder configuration parameters) when the video encoder parameters are reconfigured. For JPEG, MPEG4 and H264 extension elements have been defined that provide additional information. A device must provide the XxxOption information for all encodings supported and should additionally provide the corresponding XxxOption2 information. This response contains the available video encoder configuration options. If a video encoder configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoEncoderConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoEncoderConfigurationOptions", + "schema": { + "name": "GetVideoEncoderConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional video encoder configuration token that specifies an existing configuration that the options are intended for." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ProfileToken that specifies an existing media profile that the options shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoEncoderConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoEncoderConfigurationOptionsResponse", + "schema": { + "name": "GetVideoEncoderConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderConfigurationOptions", + "type_name": "VideoEncoderConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "VideoEncoderConfigurationOptions", + "fields": [ + { + "name": "QualityRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of the quality values. A high value means higher quality." + }, + { + "name": "JPEG", + "type": "{http://www.onvif.org/ver10/schema}JpegOptions", + "type_name": "JpegOptions", + "definition": { + "kind": "complexType", + "name": "JpegOptions", + "fields": [ + { + "name": "ResolutionsAvailable", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported image sizes." + }, + { + "name": "FrameRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported frame rate in fps (frames per second)." + }, + { + "name": "EncodingIntervalRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported encoding interval range. The encoding interval corresponds to the number of frames divided by the encoded frames. An encoding interval value of \"1\" means that all frames are encoded." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional JPEG encoder settings ranges (See also Extension element)." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Options", + "type_name": "Mpeg4Options", + "definition": { + "kind": "complexType", + "name": "Mpeg4Options", + "fields": [ + { + "name": "ResolutionsAvailable", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported image sizes." + }, + { + "name": "GovLengthRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported group of Video frames length. This value typically corresponds to the I-Frame distance." + }, + { + "name": "FrameRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported frame rate in fps (frames per second)." + }, + { + "name": "EncodingIntervalRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported encoding interval range. The encoding interval corresponds to the number of frames divided by the encoded frames. An encoding interval value of \"1\" means that all frames are encoded." + }, + { + "name": "Mpeg4ProfilesSupported", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported MPEG-4 profiles." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional MPEG-4 encoder settings ranges (See also Extension element)." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Options", + "type_name": "H264Options", + "definition": { + "kind": "complexType", + "name": "H264Options", + "fields": [ + { + "name": "ResolutionsAvailable", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported image sizes." + }, + { + "name": "GovLengthRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported group of Video frames length. This value typically corresponds to the I-Frame distance." + }, + { + "name": "FrameRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported frame rate in fps (frames per second)." + }, + { + "name": "EncodingIntervalRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported encoding interval range. The encoding interval corresponds to the number of frames divided by the encoded frames. An encoding interval value of \"1\" means that all frames are encoded." + }, + { + "name": "H264ProfilesSupported", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported H.264 profiles." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional H.264 encoder settings ranges (See also Extension element)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderOptionsExtension", + "type_name": "VideoEncoderOptionsExtension", + "definition": { + "kind": "complexType", + "name": "VideoEncoderOptionsExtension", + "fields": [ + { + "name": "JPEG", + "type": "{http://www.onvif.org/ver10/schema}JpegOptions2", + "type_name": "JpegOptions2", + "definition": { + "kind": "complexType", + "name": "JpegOptions2", + "base": "{http://www.onvif.org/ver10/schema}JpegOptions", + "base_definition": { + "kind": "complexType", + "name": "JpegOptions", + "fields": [ + { + "name": "ResolutionsAvailable", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported image sizes." + }, + { + "name": "FrameRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported frame rate in fps (frames per second)." + }, + { + "name": "EncodingIntervalRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported encoding interval range. The encoding interval corresponds to the number of frames divided by the encoded frames. An encoding interval value of \"1\" means that all frames are encoded." + } + ] + }, + "fields": [ + { + "name": "BitrateRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported range of encoded bitrate in kbps." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional JPEG encoder settings ranges." + }, + { + "name": "MPEG4", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Options2", + "type_name": "Mpeg4Options2", + "definition": { + "kind": "complexType", + "name": "Mpeg4Options2", + "base": "{http://www.onvif.org/ver10/schema}Mpeg4Options", + "base_definition": { + "kind": "complexType", + "name": "Mpeg4Options", + "fields": [ + { + "name": "ResolutionsAvailable", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported image sizes." + }, + { + "name": "GovLengthRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported group of Video frames length. This value typically corresponds to the I-Frame distance." + }, + { + "name": "FrameRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported frame rate in fps (frames per second)." + }, + { + "name": "EncodingIntervalRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported encoding interval range. The encoding interval corresponds to the number of frames divided by the encoded frames. An encoding interval value of \"1\" means that all frames are encoded." + }, + { + "name": "Mpeg4ProfilesSupported", + "type": "{http://www.onvif.org/ver10/schema}Mpeg4Profile", + "type_name": "Mpeg4Profile", + "definition": { + "kind": "simpleType", + "name": "Mpeg4Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "SP" + }, + { + "value": "ASP" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported MPEG-4 profiles." + } + ] + }, + "fields": [ + { + "name": "BitrateRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported range of encoded bitrate in kbps." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional MPEG-4 encoder settings ranges." + }, + { + "name": "H264", + "type": "{http://www.onvif.org/ver10/schema}H264Options2", + "type_name": "H264Options2", + "definition": { + "kind": "complexType", + "name": "H264Options2", + "base": "{http://www.onvif.org/ver10/schema}H264Options", + "base_definition": { + "kind": "complexType", + "name": "H264Options", + "fields": [ + { + "name": "ResolutionsAvailable", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported image sizes." + }, + { + "name": "GovLengthRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported group of Video frames length. This value typically corresponds to the I-Frame distance." + }, + { + "name": "FrameRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported frame rate in fps (frames per second)." + }, + { + "name": "EncodingIntervalRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported encoding interval range. The encoding interval corresponds to the number of frames divided by the encoded frames. An encoding interval value of \"1\" means that all frames are encoded." + }, + { + "name": "H264ProfilesSupported", + "type": "{http://www.onvif.org/ver10/schema}H264Profile", + "type_name": "H264Profile", + "definition": { + "kind": "simpleType", + "name": "H264Profile", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Baseline" + }, + { + "value": "Main" + }, + { + "value": "Extended" + }, + { + "value": "High" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported H.264 profiles." + } + ] + }, + "fields": [ + { + "name": "BitrateRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported range of encoded bitrate in kbps." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional H.264 encoder settings ranges." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoderOptionsExtension2", + "type_name": "VideoEncoderOptionsExtension2", + "definition": { + "kind": "complexType", + "name": "VideoEncoderOptionsExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "GuaranteedFrameRateSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoderConfiguration element." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioSourceConfigurationOptions", + "port_type": "Media", + "description": "This operation returns the available options (supported values and ranges for audio source configuration parameters) when the audio source parameters are reconfigured. If an audio source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourceConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourceConfigurationOptions", + "schema": { + "name": "GetAudioSourceConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional audio source configuration token that specifies an existing configuration that the options are intended for." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ProfileToken that specifies an existing media profile that the options shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourceConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioSourceConfigurationOptionsResponse", + "schema": { + "name": "GetAudioSourceConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfigurationOptions", + "type_name": "AudioSourceConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfigurationOptions", + "fields": [ + { + "name": "InputTokensAvailable", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the audio source the configuration can be used for." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceOptionsExtension", + "type_name": "AudioSourceOptionsExtension", + "definition": { + "kind": "complexType", + "name": "AudioSourceOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This message contains the audio source configuration options. If a audio source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioEncoderConfigurationOptions", + "port_type": "Media", + "description": "This operation returns the available options (supported values and ranges for audio encoder configuration parameters) when the audio encoder parameters are reconfigured.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioEncoderConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioEncoderConfigurationOptions", + "schema": { + "name": "GetAudioEncoderConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional audio encoder configuration token that specifies an existing configuration that the options are intended for." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ProfileToken that specifies an existing media profile that the options shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioEncoderConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioEncoderConfigurationOptionsResponse", + "schema": { + "name": "GetAudioEncoderConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfigurationOptions", + "type_name": "AudioEncoderConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfigurationOptions", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoderConfigurationOption", + "type_name": "AudioEncoderConfigurationOption", + "definition": { + "kind": "complexType", + "name": "AudioEncoderConfigurationOption", + "fields": [ + { + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoding", + "type_name": "AudioEncoding", + "definition": { + "kind": "simpleType", + "name": "AudioEncoding", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "G711" + }, + { + "value": "G726" + }, + { + "value": "AAC" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The encoding used for audio data (either G.711, G.726 or AAC)." + }, + { + "name": "BitrateList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps for the specified Encoding." + }, + { + "name": "SampleRateList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported Sample Rates in kHz for the specified Encoding." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "list of supported AudioEncoderConfigurations" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This message contains the audio encoder configuration options. If a audio encoder configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetMetadataConfigurationOptions", + "port_type": "Media", + "description": "This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetMetadataConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetMetadataConfigurationOptions", + "schema": { + "name": "GetMetadataConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional metadata configuration token that specifies an existing configuration that the options are intended for." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ProfileToken that specifies an existing media profile that the options shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetMetadataConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetMetadataConfigurationOptionsResponse", + "schema": { + "name": "GetMetadataConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationOptions", + "type_name": "MetadataConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationOptions", + "fields": [ + { + "name": "PTZStatusFilterOptions", + "type": "{http://www.onvif.org/ver10/schema}PTZStatusFilterOptions", + "type_name": "PTZStatusFilterOptions", + "definition": { + "kind": "complexType", + "name": "PTZStatusFilterOptions", + "fields": [ + { + "name": "PanTiltStatusSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the device is able to stream pan or tilt status information." + }, + { + "name": "ZoomStatusSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the device is able to stream zoom status information." + }, + { + "name": "PanTiltPositionSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the device is able to stream the pan or tilt position." + }, + { + "name": "ZoomPositionSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the device is able to stream zoom position information." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZStatusFilterOptionsExtension", + "type_name": "PTZStatusFilterOptionsExtension", + "definition": { + "kind": "complexType", + "name": "PTZStatusFilterOptionsExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "FieldOfViewSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the device is able to stream the field-of-view information." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SensorDataFilterOptions", + "type": "{http://www.onvif.org/ver10/schema}SensorDataFilterOptions", + "type_name": "SensorDataFilterOptions", + "definition": { + "kind": "complexType", + "name": "SensorDataFilterOptions", + "fields": [ + { + "name": "SensorIDFilterSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the device supports filtering sensor data by SensorID." + }, + { + "name": "TypeFilterSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the device supports filtering sensor data by Type." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element indicating the sensor data filtering capabilities of the device." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationOptionsExtension", + "type_name": "MetadataConfigurationOptionsExtension", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationOptionsExtension", + "fields": [ + { + "name": "CompressionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported metadata compression type. Its options shall be chosen from tt:MetadataCompressionType." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationOptionsExtension2", + "type_name": "MetadataConfigurationOptionsExtension2", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationOptionsExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "GeoLocation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "True if the device is able to stream the Geo Located positions of each target." + }, + { + "use": "optional", + "name": "MaxContentFilterSize", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "A device signalling support for content filtering shall support expressions with the provided expression size." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithms", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "If secure RTSP streaming is supported, this shall return the list of supported cryptographic algorithms as defined by tt:SrtpSecurityAlgorithms." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This message contains the metadata configuration options. If a metadata configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioOutputConfigurationOptions", + "port_type": "Media", + "description": "This operation returns the available options (supported values and ranges for audio output configuration parameters) for configuring an audio output.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputConfigurationOptions", + "schema": { + "name": "GetAudioOutputConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional audio output configuration token that specifies an existing configuration that the options are intended for." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ProfileToken that specifies an existing media profile that the options shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioOutputConfigurationOptionsResponse", + "schema": { + "name": "GetAudioOutputConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfigurationOptions", + "type_name": "AudioOutputConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfigurationOptions", + "fields": [ + { + "name": "OutputTokensAvailable", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the physical Audio outputs (typically one)." + }, + { + "name": "SendPrimacyOptions", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\tneeds to be switched.\n\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t
\n\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevelRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Minimum and maximum level range supported for this Output." + }, + { + "name": "EQPresetScheduleSupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether EQPreset scheduling is supported." + }, + { + "name": "EQPresets", + "type": "{http://www.onvif.org/ver10/schema}EQPreset", + "type_name": "EQPreset", + "definition": { + "kind": "complexType", + "name": "EQPreset", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique identifier for the preset." + }, + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Preset name. (Readonly)" + }, + { + "name": "isDefault", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This indicates whether the EQ preset is designated as the default. When the scheduler is inactive, this preset will be applied. Only one preset can be set as the default among the EQ presets linked to an audio output. If all presets have isDefault set to false, the device may automatically select one preset as the default." + }, + { + "name": "ScheduleToken", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional schedule token (if supported)." + }, + { + "name": "isFrequencyDecibelEditable", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the device allows changing the decibel level for frequencies. (Readonly)" + }, + { + "name": "FrequencyDecibelPair", + "type": "{http://www.onvif.org/ver10/schema}FrequencyDecibelPair", + "type_name": "FrequencyDecibelPair", + "definition": { + "kind": "complexType", + "name": "FrequencyDecibelPair", + "fields": [ + { + "name": "CenterFrequency", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The center frequency of the band in hertz (Readonly). For example, value of 1000 refers to 1kHz and 2000 refers to 2kHz." + }, + { + "name": "Decibel", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Decibel value associated with the center frequency." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of frequency decibel pairs, each defined by a center frequency and its corresponding decibel value." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported EQPresets." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This message contains the audio output configuration options. If a audio output configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetAudioDecoderConfigurationOptions", + "port_type": "Media", + "description": "This command list the audio decoding capabilities for a given profile and configuration of a device.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioDecoderConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioDecoderConfigurationOptions", + "schema": { + "name": "GetAudioDecoderConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional audio decoder configuration token that specifies an existing configuration that the options are intended for." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ProfileToken that specifies an existing media profile that the options shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetAudioDecoderConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetAudioDecoderConfigurationOptionsResponse", + "schema": { + "name": "GetAudioDecoderConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfigurationOptions", + "type_name": "AudioDecoderConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfigurationOptions", + "fields": [ + { + "name": "AACDecOptions", + "type": "{http://www.onvif.org/ver10/schema}AACDecOptions", + "type_name": "AACDecOptions", + "definition": { + "kind": "complexType", + "name": "AACDecOptions", + "fields": [ + { + "name": "Bitrate", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps." + }, + { + "name": "SampleRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported sample rates in kHz" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode AAC encoded audio this section describes the supported configurations" + }, + { + "name": "G711DecOptions", + "type": "{http://www.onvif.org/ver10/schema}G711DecOptions", + "type_name": "G711DecOptions", + "definition": { + "kind": "complexType", + "name": "G711DecOptions", + "fields": [ + { + "name": "Bitrate", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps." + }, + { + "name": "SampleRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported sample rates in kHz" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode G711 encoded audio this section describes the supported configurations" + }, + { + "name": "G726DecOptions", + "type": "{http://www.onvif.org/ver10/schema}G726DecOptions", + "type_name": "G726DecOptions", + "definition": { + "kind": "complexType", + "name": "G726DecOptions", + "fields": [ + { + "name": "Bitrate", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps." + }, + { + "name": "SampleRateRange", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported sample rates in kHz" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the device is able to decode G726 encoded audio this section describes the supported configurations" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfigurationOptionsExtension", + "type_name": "AudioDecoderConfigurationOptionsExtension", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfigurationOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This message contains the audio decoder configuration options. If a audio decoder configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetGuaranteedNumberOfVideoEncoderInstances", + "port_type": "Media", + "description": "The GetGuaranteedNumberOfVideoEncoderInstances command can be used to request the minimum number of guaranteed video encoder instances (applications) per Video Source Configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetGuaranteedNumberOfVideoEncoderInstancesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetGuaranteedNumberOfVideoEncoderInstances", + "schema": { + "name": "GetGuaranteedNumberOfVideoEncoderInstances", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the video source configuration" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetGuaranteedNumberOfVideoEncoderInstancesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetGuaranteedNumberOfVideoEncoderInstancesResponse", + "schema": { + "name": "GetGuaranteedNumberOfVideoEncoderInstancesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TotalNumber", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The minimum guaranteed total number of encoder instances (applications) per VideoSourceConfiguration. The device is able to deliver the TotalNumber of streams" + }, + { + "name": "JPEG", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If a device limits the number of instances for respective Video Codecs the response contains the information how many Jpeg streams can be set up at the same time per VideoSource." + }, + { + "name": "H264", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If a device limits the number of instances for respective Video Codecs the response contains the information how many H264 streams can be set up at the same time per VideoSource." + }, + { + "name": "MPEG4", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If a device limits the number of instances for respective Video Codecs the response contains the information how many Mpeg4 streams can be set up at the same time per VideoSource." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetStreamUri", + "port_type": "Media", + "description": "This operation requests a URI that can be used to initiate a live media stream using RTSP as the control protocol. The returned URI shall remain valid indefinitely even if the profile is changed. The ValidUntilConnect, ValidUntilReboot and Timeout Parameter shall be set accordingly (ValidUntilConnect=false, ValidUntilReboot=false, timeout=PT0S). The correct syntax for the StreamSetup element for these media stream setups defined in 5.1.1 of the streaming specification are as follows: RTP unicast over UDP: StreamType = \"RTP_unicast\", TransportProtocol = \"UDP\" RTP over RTSP over HTTP over TCP: StreamType = \"RTP_unicast\", TransportProtocol = \"HTTP\" RTP over RTSP over TCP: StreamType = \"RTP_unicast\", TransportProtocol = \"RTSP\" If a multicast stream is requested at least one of VideoEncoderConfiguration, AudioEncoderConfiguration and MetadataConfiguration shall have a valid multicast setting. For full compatibility with other ONVIF services a device should not generate Uris longer than 128 octets.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetStreamUriRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetStreamUri", + "schema": { + "name": "GetStreamUri", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StreamSetup", + "type": "{http://www.onvif.org/ver10/schema}StreamSetup", + "type_name": "StreamSetup", + "definition": { + "kind": "complexType", + "name": "StreamSetup", + "fields": [ + { + "name": "Stream", + "type": "{http://www.onvif.org/ver10/schema}StreamType", + "type_name": "StreamType", + "definition": { + "kind": "simpleType", + "name": "StreamType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "RTP-Unicast" + }, + { + "value": "RTP-Multicast" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines if a multicast or unicast stream is requested." + }, + { + "name": "Transport", + "type": "{http://www.onvif.org/ver10/schema}Transport", + "type_name": "Transport", + "definition": { + "kind": "complexType", + "name": "Transport", + "fields": [ + { + "name": "Protocol", + "type": "{http://www.onvif.org/ver10/schema}TransportProtocol", + "type_name": "TransportProtocol", + "definition": { + "kind": "simpleType", + "name": "TransportProtocol", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "UDP" + }, + { + "value": "TCP", + "description": "This value is deprecated." + }, + { + "value": "RTSP" + }, + { + "value": "HTTP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP." + }, + { + "name": "Tunnel", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Deprecated: optional element to describe further tunnel options." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Stream Setup that should be used with the uri." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetStreamUriResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetStreamUriResponse", + "schema": { + "name": "GetStreamUriResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "MediaUri", + "type": "{http://www.onvif.org/ver10/schema}MediaUri", + "type_name": "MediaUri", + "definition": { + "kind": "complexType", + "name": "MediaUri", + "fields": [ + { + "name": "Uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Stable Uri to be used for requesting the media stream." + }, + { + "name": "InvalidAfterConnect", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the Uri is only valid until the connection is established. The value shall be set to \"false\"." + }, + { + "name": "InvalidAfterReboot", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the Uri is invalid after a reboot of the device. The value shall be set to \"false\"." + }, + { + "name": "Timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Duration how long the Uri is valid. This parameter shall be set to PT0S to indicate that this stream URI is indefinitely valid even if the profile changes." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "StartMulticastStreaming", + "port_type": "Media", + "description": "This command starts multicast streaming using a specified media profile of a device. Streaming continues until StopMulticastStreaming is called for the same Profile. The streaming shall continue after a reboot of the device until a StopMulticastStreaming request is received. The multicast address, port and TTL are configured in the VideoEncoderConfiguration, AudioEncoderConfiguration and MetadataConfiguration respectively.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}StartMulticastStreamingRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}StartMulticastStreaming", + "schema": { + "name": "StartMulticastStreaming", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of the Profile that is used to define the multicast stream." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}StartMulticastStreamingResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}StartMulticastStreamingResponse", + "schema": { + "name": "StartMulticastStreamingResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "StopMulticastStreaming", + "port_type": "Media", + "description": "This command stop multicast streaming using a specified media profile of a device", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}StopMulticastStreamingRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}StopMulticastStreaming", + "schema": { + "name": "StopMulticastStreaming", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of the Profile that is used to define the multicast stream." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}StopMulticastStreamingResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}StopMulticastStreamingResponse", + "schema": { + "name": "StopMulticastStreamingResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "SetSynchronizationPoint", + "port_type": "Media", + "description": "Synchronization points allow clients to decode and correctly use all data after the synchronization point. For example, if a video stream is configured with a large I-frame distance and a client loses a single packet, the client does not display video until the next I-frame is transmitted. In such cases, the client can request a Synchronization Point which enforces the device to add an I-Frame as soon as possible. Clients can request Synchronization Points for profiles. The device shall add synchronization points for all streams associated with this profile. Similarly, a synchronization point is used to get an update on full PTZ or event status through the metadata stream. If a video stream is associated with the profile, an I-frame shall be added to this video stream. If a PTZ metadata stream is associated to the profile, the PTZ position shall be repeated within the metadata stream.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetSynchronizationPointRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetSynchronizationPoint", + "schema": { + "name": "SetSynchronizationPoint", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a Profile reference for which a Synchronization Point is requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetSynchronizationPointResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetSynchronizationPointResponse", + "schema": { + "name": "SetSynchronizationPointResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetSnapshotUri", + "port_type": "Media", + "description": "A client uses the GetSnapshotUri command to obtain a JPEG snapshot from the device. The returned URI shall remain valid indefinitely even if the profile is changed. The ValidUntilConnect, ValidUntilReboot and Timeout Parameter shall be set accordingly (ValidUntilConnect=false, ValidUntilReboot=false, timeout=PT0S). The URI can be used for acquiring a JPEG image through an HTTP GET operation. The image encoding will always be JPEG regardless of the encoding setting in the media profile. The Jpeg settings (like resolution or quality) may be taken from the profile if suitable. The provided image will be updated automatically and independent from calls to GetSnapshotUri.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetSnapshotUriRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetSnapshotUri", + "schema": { + "name": "GetSnapshotUri", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ProfileToken element indicates the media profile to use and will define the source and dimensions of the snapshot." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetSnapshotUriResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetSnapshotUriResponse", + "schema": { + "name": "GetSnapshotUriResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "MediaUri", + "type": "{http://www.onvif.org/ver10/schema}MediaUri", + "type_name": "MediaUri", + "definition": { + "kind": "complexType", + "name": "MediaUri", + "fields": [ + { + "name": "Uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Stable Uri to be used for requesting the media stream." + }, + { + "name": "InvalidAfterConnect", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the Uri is only valid until the connection is established. The value shall be set to \"false\"." + }, + { + "name": "InvalidAfterReboot", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the Uri is invalid after a reboot of the device. The value shall be set to \"false\"." + }, + { + "name": "Timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Duration how long the Uri is valid. This parameter shall be set to PT0S to indicate that this stream URI is indefinitely valid even if the profile changes." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetVideoSourceModes", + "port_type": "Media", + "description": "A device returns the information for current video source mode and settable video source modes of specified video source. A device that indicates a capability of VideoSourceModes shall support this command.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceModesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceModes", + "schema": { + "name": "GetVideoSourceModes", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a video source reference for which a video source mode is requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceModesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetVideoSourceModesResponse", + "schema": { + "name": "GetVideoSourceModesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceModes", + "type": "{http://www.onvif.org/ver10/media/wsdl}VideoSourceMode", + "type_name": "VideoSourceMode", + "definition": { + "kind": "complexType", + "name": "VideoSourceMode", + "fields": [ + { + "name": "MaxFramerate", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Max frame rate in frames per second for this video source mode." + }, + { + "name": "MaxResolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Max horizontal and vertical resolution for this video source mode." + }, + { + "name": "Encodings", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indication which encodings are supported for this video source. The list may contain one or more enumeration values of tt:VideoEncoding." + }, + { + "name": "Reboot", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "After setting the mode if a device starts to reboot this value is true. If a device change the mode without rebooting this value is false. If true, configured parameters may not be guaranteed by the device after rebooting." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of this video source mode. This field should be described in English." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/media/wsdl}VideoSourceModeExtension", + "type_name": "VideoSourceModeExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceModeExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Indicate token for video source mode." + }, + { + "use": "optional", + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication of whether this mode is active. If active this value is true. In case of non-indication, it means as false. The value of true shall be had by only one video source mode." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Return the information for specified video source mode." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "SetVideoSourceMode", + "port_type": "Media", + "description": "SetVideoSourceMode changes the media profile structure relating to video source for the specified video source mode. A device that indicates a capability of VideoSourceModes shall support this command. The behavior after changing the mode is not defined in this specification.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetVideoSourceModeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetVideoSourceMode", + "schema": { + "name": "SetVideoSourceMode", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a video source reference for which a video source mode is requested." + }, + { + "name": "VideoSourceModeToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicate video source mode." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetVideoSourceModeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetVideoSourceModeResponse", + "schema": { + "name": "SetVideoSourceModeResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Reboot", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The response contains information about rebooting after returning response. When Reboot is set true, a device will reboot automatically after setting mode." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetOSDs", + "port_type": "Media", + "description": "Get the OSDs.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetOSDsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetOSDs", + "schema": { + "name": "GetOSDs", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Video Source Configuration, which has OSDs associated with are requested. If token not exist, request all available OSDs." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetOSDsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetOSDsResponse", + "schema": { + "name": "GetOSDsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSDs", + "type": "{http://www.onvif.org/ver10/schema}OSDConfiguration", + "type_name": "OSDConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDConfiguration", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "VideoSourceConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}OSDReference", + "type_name": "OSDReference", + "definition": { + "kind": "complexType", + "name": "OSDReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the video source configuration." + }, + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}OSDType", + "type_name": "OSDType", + "definition": { + "kind": "simpleType", + "name": "OSDType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Text" + }, + { + "value": "Image" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of OSD." + }, + { + "name": "Position", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfiguration", + "type_name": "OSDPosConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDPosConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "For OSD position type, following are the pre-defined:
  • UpperLeft
    • \n\t\t\t\t\t\t
  • UpperRight
    • \n\t\t\t\t\t\t
  • LowerLeft
    • \n\t\t\t\t\t\t
  • LowerRight
    • \n\t\t\t\t\t\t
  • Custom
" + }, + { + "name": "Pos", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfigurationExtension", + "type_name": "OSDPosConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDPosConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Position configuration of OSD." + }, + { + "name": "TextString", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfiguration", + "type_name": "OSDTextConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDTextConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The following OSD Text Type are defined:
    \n\t\t\t\t\t\t\t
  • Plain - The Plain type means the OSD is shown as a text string which defined in the \"PlainText\" item.
    • \n\t\t\t\t\t\t\t
  • Date - The Date type means the OSD is shown as a date, format of which should be present in the \"DateFormat\" item.
    • \n\t\t\t\t\t\t\t
  • Time - The Time type means the OSD is shown as a time, format of which should be present in the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t\t
  • DateAndTime - The DateAndTime type means the OSD is shown as date and time, format of which should be present in the \"DateFormat\" and the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "DateFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD date formats. This element shall be present when the value of Type field has Date or DateAndTime. The following DateFormat are defined:
    \n\t\t\t\t\t\t\t
  • M/d/yyyy - e.g. 3/6/2013
    • \n\t\t\t\t\t\t\t
  • MM/dd/yyyy - e.g. 03/06/2013
    • \n\t\t\t\t\t\t\t
  • dd/MM/yyyy - e.g. 06/03/2013
    • \n\t\t\t\t\t\t\t
  • yyyy/MM/dd - e.g. 2013/03/06
    • \n\t\t\t\t\t\t\t
  • yyyy-MM-dd - e.g. 2013-06-03
    • \n\t\t\t\t\t\t\t
  • dddd, MMMM dd, yyyy - e.g. Wednesday, March 06, 2013
    • \n\t\t\t\t\t\t\t
  • MMMM dd, yyyy - e.g. March 06, 2013
    • \n\t\t\t\t\t\t\t
  • dd MMMM, yyyy - e.g. 06 March, 2013
    • \n\t\t\t\t\t\t
" + }, + { + "name": "TimeFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD time formats. This element shall be present when the value of Type field has Time or DateAndTime. The following TimeFormat are defined:
    \n\t\t\t\t\t\t\t
  • h:mm:ss tt - e.g. 2:14:21 PM
    • \n\t\t\t\t\t\t\t
  • hh:mm:ss tt - e.g. 02:14:21 PM
    • \n\t\t\t\t\t\t\t
  • H:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t\t
  • HH:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t
" + }, + { + "name": "FontSize", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font size of the text in pt." + }, + { + "name": "FontColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font color of the text." + }, + { + "name": "BackgroundColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Background color of the text." + }, + { + "name": "PlainText", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The content of text to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfigurationExtension", + "type_name": "OSDTextConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDTextConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "IsPersistentText", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "This flag is applicable for Type Plain and defaults to true. When set to false the PlainText content will not be persistent across device reboots." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Text configuration of OSD. It shall be present when the value of Type field is Text." + }, + { + "name": "Image", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfiguration", + "type_name": "OSDImgConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDImgConfiguration", + "fields": [ + { + "name": "ImgPath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The URI of the image which to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfigurationExtension", + "type_name": "OSDImgConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDImgConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Image configuration of OSD. It shall be present when the value of Type field is Image" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDConfigurationExtension", + "type_name": "OSDConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of requested OSDs." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetOSD", + "port_type": "Media", + "description": "Get the OSD.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetOSDRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetOSD", + "schema": { + "name": "GetOSD", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSDToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The GetOSD command fetches the OSD configuration if the OSD token is known." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetOSDResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetOSDResponse", + "schema": { + "name": "GetOSDResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSD", + "type": "{http://www.onvif.org/ver10/schema}OSDConfiguration", + "type_name": "OSDConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDConfiguration", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "VideoSourceConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}OSDReference", + "type_name": "OSDReference", + "definition": { + "kind": "complexType", + "name": "OSDReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the video source configuration." + }, + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}OSDType", + "type_name": "OSDType", + "definition": { + "kind": "simpleType", + "name": "OSDType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Text" + }, + { + "value": "Image" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of OSD." + }, + { + "name": "Position", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfiguration", + "type_name": "OSDPosConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDPosConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "For OSD position type, following are the pre-defined:
  • UpperLeft
    • \n\t\t\t\t\t\t
  • UpperRight
    • \n\t\t\t\t\t\t
  • LowerLeft
    • \n\t\t\t\t\t\t
  • LowerRight
    • \n\t\t\t\t\t\t
  • Custom
" + }, + { + "name": "Pos", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfigurationExtension", + "type_name": "OSDPosConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDPosConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Position configuration of OSD." + }, + { + "name": "TextString", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfiguration", + "type_name": "OSDTextConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDTextConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The following OSD Text Type are defined:
    \n\t\t\t\t\t\t\t
  • Plain - The Plain type means the OSD is shown as a text string which defined in the \"PlainText\" item.
    • \n\t\t\t\t\t\t\t
  • Date - The Date type means the OSD is shown as a date, format of which should be present in the \"DateFormat\" item.
    • \n\t\t\t\t\t\t\t
  • Time - The Time type means the OSD is shown as a time, format of which should be present in the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t\t
  • DateAndTime - The DateAndTime type means the OSD is shown as date and time, format of which should be present in the \"DateFormat\" and the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "DateFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD date formats. This element shall be present when the value of Type field has Date or DateAndTime. The following DateFormat are defined:
    \n\t\t\t\t\t\t\t
  • M/d/yyyy - e.g. 3/6/2013
    • \n\t\t\t\t\t\t\t
  • MM/dd/yyyy - e.g. 03/06/2013
    • \n\t\t\t\t\t\t\t
  • dd/MM/yyyy - e.g. 06/03/2013
    • \n\t\t\t\t\t\t\t
  • yyyy/MM/dd - e.g. 2013/03/06
    • \n\t\t\t\t\t\t\t
  • yyyy-MM-dd - e.g. 2013-06-03
    • \n\t\t\t\t\t\t\t
  • dddd, MMMM dd, yyyy - e.g. Wednesday, March 06, 2013
    • \n\t\t\t\t\t\t\t
  • MMMM dd, yyyy - e.g. March 06, 2013
    • \n\t\t\t\t\t\t\t
  • dd MMMM, yyyy - e.g. 06 March, 2013
    • \n\t\t\t\t\t\t
" + }, + { + "name": "TimeFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD time formats. This element shall be present when the value of Type field has Time or DateAndTime. The following TimeFormat are defined:
    \n\t\t\t\t\t\t\t
  • h:mm:ss tt - e.g. 2:14:21 PM
    • \n\t\t\t\t\t\t\t
  • hh:mm:ss tt - e.g. 02:14:21 PM
    • \n\t\t\t\t\t\t\t
  • H:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t\t
  • HH:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t
" + }, + { + "name": "FontSize", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font size of the text in pt." + }, + { + "name": "FontColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font color of the text." + }, + { + "name": "BackgroundColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Background color of the text." + }, + { + "name": "PlainText", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The content of text to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfigurationExtension", + "type_name": "OSDTextConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDTextConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "IsPersistentText", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "This flag is applicable for Type Plain and defaults to true. When set to false the PlainText content will not be persistent across device reboots." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Text configuration of OSD. It shall be present when the value of Type field is Text." + }, + { + "name": "Image", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfiguration", + "type_name": "OSDImgConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDImgConfiguration", + "fields": [ + { + "name": "ImgPath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The URI of the image which to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfigurationExtension", + "type_name": "OSDImgConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDImgConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Image configuration of OSD. It shall be present when the value of Type field is Image" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDConfigurationExtension", + "type_name": "OSDConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested OSD configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "GetOSDOptions", + "port_type": "Media", + "description": "Get the OSD Options.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetOSDOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetOSDOptions", + "schema": { + "name": "GetOSDOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Video Source Configuration Token that specifies an existing video source configuration that the options shall be compatible with." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}GetOSDOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}GetOSDOptionsResponse", + "schema": { + "name": "GetOSDOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSDOptions", + "type": "{http://www.onvif.org/ver10/schema}OSDConfigurationOptions", + "type_name": "OSDConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "OSDConfigurationOptions", + "fields": [ + { + "name": "MaximumNumberOfOSDs", + "type": "{http://www.onvif.org/ver10/schema}MaximumNumberOfOSDs", + "type_name": "MaximumNumberOfOSDs", + "definition": { + "kind": "complexType", + "name": "MaximumNumberOfOSDs", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Total", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "optional", + "name": "Image", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "optional", + "name": "PlainText", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "optional", + "name": "Date", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "optional", + "name": "Time", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "optional", + "name": "DateAndTime", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum number of OSD configurations supported for the specified video source configuration. If the configuration does not support OSDs, this value shall be zero and the Type and PositionOption elements are ignored. If a device limits the number of instances by OSDType, it shall indicate the supported number for each type via the related attribute." + }, + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}OSDType", + "type_name": "OSDType", + "definition": { + "kind": "simpleType", + "name": "OSDType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Text" + }, + { + "value": "Image" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List supported type of OSD configuration. When a device indicates the supported number for each types in MaximumNumberOfOSDs, related type shall be presented. A device shall return Option element relating to listed type." + }, + { + "name": "PositionOption", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List available OSD position type. Following are the pre-defined:
  • UpperLeft
    • \n\t\t\t\t\t\t
  • UpperRight
    • \n\t\t\t\t\t\t
  • LowerLeft
    • \n\t\t\t\t\t\t
  • LowerRight
    • \n\t\t\t\t\t\t
  • Custom
" + }, + { + "name": "TextOption", + "type": "{http://www.onvif.org/ver10/schema}OSDTextOptions", + "type_name": "OSDTextOptions", + "definition": { + "kind": "complexType", + "name": "OSDTextOptions", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported OSD text type. When a device indicates the supported number relating to Text type in MaximumNumberOfOSDs, the type shall be presented." + }, + { + "name": "FontSizeRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Range of the font size value." + }, + { + "name": "DateFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported date format." + }, + { + "name": "TimeFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported time format." + }, + { + "name": "FontColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColorOptions", + "type_name": "OSDColorOptions", + "definition": { + "kind": "complexType", + "name": "OSDColorOptions", + "description": "Describe the option of the color and its transparency.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorOptions", + "type_name": "ColorOptions", + "definition": { + "kind": "complexType", + "name": "ColorOptions", + "description": "Describe the colors supported. Either list each color or define the range of color values.", + "fields": [ + { + "name": "ColorList", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List the supported color." + }, + { + "name": "ColorspaceRange", + "type": "{http://www.onvif.org/ver10/schema}ColorspaceRange", + "type_name": "ColorspaceRange", + "definition": { + "kind": "complexType", + "name": "ColorspaceRange", + "fields": [ + { + "name": "X", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Y", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Z", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Define the range of color supported." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional list of supported colors." + }, + { + "name": "Transparent", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Range of the transparent level. Larger means more transparent." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDColorOptionsExtension", + "type_name": "OSDColorOptionsExtension", + "definition": { + "kind": "complexType", + "name": "OSDColorOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported font color." + }, + { + "name": "BackgroundColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColorOptions", + "type_name": "OSDColorOptions", + "definition": { + "kind": "complexType", + "name": "OSDColorOptions", + "description": "Describe the option of the color and its transparency.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorOptions", + "type_name": "ColorOptions", + "definition": { + "kind": "complexType", + "name": "ColorOptions", + "description": "Describe the colors supported. Either list each color or define the range of color values.", + "fields": [ + { + "name": "ColorList", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List the supported color." + }, + { + "name": "ColorspaceRange", + "type": "{http://www.onvif.org/ver10/schema}ColorspaceRange", + "type_name": "ColorspaceRange", + "definition": { + "kind": "complexType", + "name": "ColorspaceRange", + "fields": [ + { + "name": "X", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Y", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Z", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Define the range of color supported." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional list of supported colors." + }, + { + "name": "Transparent", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Range of the transparent level. Larger means more transparent." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDColorOptionsExtension", + "type_name": "OSDColorOptionsExtension", + "definition": { + "kind": "complexType", + "name": "OSDColorOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported background color." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDTextOptionsExtension", + "type_name": "OSDTextOptionsExtension", + "definition": { + "kind": "complexType", + "name": "OSDTextOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Option of the OSD text configuration. This element shall be returned if the device is signaling the support for Text." + }, + { + "name": "ImageOption", + "type": "{http://www.onvif.org/ver10/schema}OSDImgOptions", + "type_name": "OSDImgOptions", + "definition": { + "kind": "complexType", + "name": "OSDImgOptions", + "fields": [ + { + "name": "ImagePath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of available image URIs." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDImgOptionsExtension", + "type_name": "OSDImgOptionsExtension", + "definition": { + "kind": "complexType", + "name": "OSDImgOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "FormatsSupported", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported image MIME types, such as \"image/png\"." + }, + { + "use": "optional", + "name": "MaxSize", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The maximum size (in bytes) of the image that can be uploaded." + }, + { + "use": "optional", + "name": "MaxWidth", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The maximum width (in pixels) of the image that can be uploaded." + }, + { + "use": "optional", + "name": "MaxHeight", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The maximum height (in pixels) of the image that can be uploaded." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Option of the OSD image configuration. This element shall be returned if the device is signaling the support for Image." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDConfigurationOptionsExtension", + "type_name": "OSDConfigurationOptionsExtension", + "definition": { + "kind": "complexType", + "name": "OSDConfigurationOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "SetOSD", + "port_type": "Media", + "description": "Set the OSD", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetOSDRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetOSD", + "schema": { + "name": "SetOSD", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSD", + "type": "{http://www.onvif.org/ver10/schema}OSDConfiguration", + "type_name": "OSDConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDConfiguration", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "VideoSourceConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}OSDReference", + "type_name": "OSDReference", + "definition": { + "kind": "complexType", + "name": "OSDReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the video source configuration." + }, + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}OSDType", + "type_name": "OSDType", + "definition": { + "kind": "simpleType", + "name": "OSDType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Text" + }, + { + "value": "Image" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of OSD." + }, + { + "name": "Position", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfiguration", + "type_name": "OSDPosConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDPosConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "For OSD position type, following are the pre-defined:
  • UpperLeft
    • \n\t\t\t\t\t\t
  • UpperRight
    • \n\t\t\t\t\t\t
  • LowerLeft
    • \n\t\t\t\t\t\t
  • LowerRight
    • \n\t\t\t\t\t\t
  • Custom
" + }, + { + "name": "Pos", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfigurationExtension", + "type_name": "OSDPosConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDPosConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Position configuration of OSD." + }, + { + "name": "TextString", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfiguration", + "type_name": "OSDTextConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDTextConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The following OSD Text Type are defined:
    \n\t\t\t\t\t\t\t
  • Plain - The Plain type means the OSD is shown as a text string which defined in the \"PlainText\" item.
    • \n\t\t\t\t\t\t\t
  • Date - The Date type means the OSD is shown as a date, format of which should be present in the \"DateFormat\" item.
    • \n\t\t\t\t\t\t\t
  • Time - The Time type means the OSD is shown as a time, format of which should be present in the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t\t
  • DateAndTime - The DateAndTime type means the OSD is shown as date and time, format of which should be present in the \"DateFormat\" and the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "DateFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD date formats. This element shall be present when the value of Type field has Date or DateAndTime. The following DateFormat are defined:
    \n\t\t\t\t\t\t\t
  • M/d/yyyy - e.g. 3/6/2013
    • \n\t\t\t\t\t\t\t
  • MM/dd/yyyy - e.g. 03/06/2013
    • \n\t\t\t\t\t\t\t
  • dd/MM/yyyy - e.g. 06/03/2013
    • \n\t\t\t\t\t\t\t
  • yyyy/MM/dd - e.g. 2013/03/06
    • \n\t\t\t\t\t\t\t
  • yyyy-MM-dd - e.g. 2013-06-03
    • \n\t\t\t\t\t\t\t
  • dddd, MMMM dd, yyyy - e.g. Wednesday, March 06, 2013
    • \n\t\t\t\t\t\t\t
  • MMMM dd, yyyy - e.g. March 06, 2013
    • \n\t\t\t\t\t\t\t
  • dd MMMM, yyyy - e.g. 06 March, 2013
    • \n\t\t\t\t\t\t
" + }, + { + "name": "TimeFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD time formats. This element shall be present when the value of Type field has Time or DateAndTime. The following TimeFormat are defined:
    \n\t\t\t\t\t\t\t
  • h:mm:ss tt - e.g. 2:14:21 PM
    • \n\t\t\t\t\t\t\t
  • hh:mm:ss tt - e.g. 02:14:21 PM
    • \n\t\t\t\t\t\t\t
  • H:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t\t
  • HH:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t
" + }, + { + "name": "FontSize", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font size of the text in pt." + }, + { + "name": "FontColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font color of the text." + }, + { + "name": "BackgroundColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Background color of the text." + }, + { + "name": "PlainText", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The content of text to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfigurationExtension", + "type_name": "OSDTextConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDTextConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "IsPersistentText", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "This flag is applicable for Type Plain and defaults to true. When set to false the PlainText content will not be persistent across device reboots." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Text configuration of OSD. It shall be present when the value of Type field is Text." + }, + { + "name": "Image", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfiguration", + "type_name": "OSDImgConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDImgConfiguration", + "fields": [ + { + "name": "ImgPath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The URI of the image which to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfigurationExtension", + "type_name": "OSDImgConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDImgConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Image configuration of OSD. It shall be present when the value of Type field is Image" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDConfigurationExtension", + "type_name": "OSDConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified OSD configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}SetOSDResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}SetOSDResponse", + "schema": { + "name": "SetOSDResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "CreateOSD", + "port_type": "Media", + "description": "Create the OSD.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}CreateOSDRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}CreateOSD", + "schema": { + "name": "CreateOSD", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSD", + "type": "{http://www.onvif.org/ver10/schema}OSDConfiguration", + "type_name": "OSDConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDConfiguration", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "VideoSourceConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}OSDReference", + "type_name": "OSDReference", + "definition": { + "kind": "complexType", + "name": "OSDReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the video source configuration." + }, + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}OSDType", + "type_name": "OSDType", + "definition": { + "kind": "simpleType", + "name": "OSDType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Text" + }, + { + "value": "Image" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of OSD." + }, + { + "name": "Position", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfiguration", + "type_name": "OSDPosConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDPosConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "For OSD position type, following are the pre-defined:
  • UpperLeft
    • \n\t\t\t\t\t\t
  • UpperRight
    • \n\t\t\t\t\t\t
  • LowerLeft
    • \n\t\t\t\t\t\t
  • LowerRight
    • \n\t\t\t\t\t\t
  • Custom
" + }, + { + "name": "Pos", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfigurationExtension", + "type_name": "OSDPosConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDPosConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Position configuration of OSD." + }, + { + "name": "TextString", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfiguration", + "type_name": "OSDTextConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDTextConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The following OSD Text Type are defined:
    \n\t\t\t\t\t\t\t
  • Plain - The Plain type means the OSD is shown as a text string which defined in the \"PlainText\" item.
    • \n\t\t\t\t\t\t\t
  • Date - The Date type means the OSD is shown as a date, format of which should be present in the \"DateFormat\" item.
    • \n\t\t\t\t\t\t\t
  • Time - The Time type means the OSD is shown as a time, format of which should be present in the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t\t
  • DateAndTime - The DateAndTime type means the OSD is shown as date and time, format of which should be present in the \"DateFormat\" and the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "DateFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD date formats. This element shall be present when the value of Type field has Date or DateAndTime. The following DateFormat are defined:
    \n\t\t\t\t\t\t\t
  • M/d/yyyy - e.g. 3/6/2013
    • \n\t\t\t\t\t\t\t
  • MM/dd/yyyy - e.g. 03/06/2013
    • \n\t\t\t\t\t\t\t
  • dd/MM/yyyy - e.g. 06/03/2013
    • \n\t\t\t\t\t\t\t
  • yyyy/MM/dd - e.g. 2013/03/06
    • \n\t\t\t\t\t\t\t
  • yyyy-MM-dd - e.g. 2013-06-03
    • \n\t\t\t\t\t\t\t
  • dddd, MMMM dd, yyyy - e.g. Wednesday, March 06, 2013
    • \n\t\t\t\t\t\t\t
  • MMMM dd, yyyy - e.g. March 06, 2013
    • \n\t\t\t\t\t\t\t
  • dd MMMM, yyyy - e.g. 06 March, 2013
    • \n\t\t\t\t\t\t
" + }, + { + "name": "TimeFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD time formats. This element shall be present when the value of Type field has Time or DateAndTime. The following TimeFormat are defined:
    \n\t\t\t\t\t\t\t
  • h:mm:ss tt - e.g. 2:14:21 PM
    • \n\t\t\t\t\t\t\t
  • hh:mm:ss tt - e.g. 02:14:21 PM
    • \n\t\t\t\t\t\t\t
  • H:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t\t
  • HH:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t
" + }, + { + "name": "FontSize", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font size of the text in pt." + }, + { + "name": "FontColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font color of the text." + }, + { + "name": "BackgroundColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Background color of the text." + }, + { + "name": "PlainText", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The content of text to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfigurationExtension", + "type_name": "OSDTextConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDTextConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "IsPersistentText", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "This flag is applicable for Type Plain and defaults to true. When set to false the PlainText content will not be persistent across device reboots." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Text configuration of OSD. It shall be present when the value of Type field is Text." + }, + { + "name": "Image", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfiguration", + "type_name": "OSDImgConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDImgConfiguration", + "fields": [ + { + "name": "ImgPath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The URI of the image which to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfigurationExtension", + "type_name": "OSDImgConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDImgConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Image configuration of OSD. It shall be present when the value of Type field is Image" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDConfigurationExtension", + "type_name": "OSDConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contain the initial OSD configuration for create." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}CreateOSDResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}CreateOSDResponse", + "schema": { + "name": "CreateOSDResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSDToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Returns Token of the newly created OSD" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + }, + { + "name": "DeleteOSD", + "port_type": "Media", + "description": "Delete the OSD.", + "input": { + "message": "{http://www.onvif.org/ver10/media/wsdl}DeleteOSDRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}DeleteOSD", + "schema": { + "name": "DeleteOSD", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSDToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This element contains a reference to the OSD configuration that should be deleted." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/media/wsdl}DeleteOSDResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/media/wsdl}DeleteOSDResponse", + "schema": { + "name": "DeleteOSDResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "MediaBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/pacs/accesscontrol.json b/docs/generated/wsdl/ver10/pacs/accesscontrol.json new file mode 100644 index 00000000..8253a7c2 --- /dev/null +++ b/docs/generated/wsdl/ver10/pacs/accesscontrol.json @@ -0,0 +1,4588 @@ +{ + "source": "ver10/pacs/accesscontrol.wsdl", + "target_namespace": "http://www.onvif.org/ver10/accesscontrol/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "PACSPort", + "description": "This operation returns the capabilities of the access control service. A device which provides the access control service shall implement this method.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}ServiceCapabilities", + "type_name": "ServiceCapabilities", + "definition": { + "kind": "complexType", + "name": "ServiceCapabilities", + "description": "The service capabilities reflect optional functionality of a service.\n\t\t\t\t\t\tThe information is static and does not change during device operation.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "MaxLimit", + "type": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "description": "The maximum number of entries returned by a single Get<Entity>List or\n\t\t\t\t\t\t\tGet<Entity> request.\n\t\t\t\t\t\t\tThe device shall never return more than this number of entities in a single response." + }, + { + "use": "optional", + "name": "MaxAccessPoints", + "type": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "default": "10", + "description": "Indicates the maximum number of access points supported by the device." + }, + { + "use": "optional", + "name": "MaxAreas", + "type": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "default": "10", + "description": "Indicates the maximum number of areas supported by the device." + }, + { + "use": "optional", + "name": "ClientSuppliedTokenSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false", + "description": "Indicates that the client is allowed to supply the token when creating access\n\t\t\t\t\t\t\tpoints and areas.\n\t\t\t\t\t\t\tTo enable the use of the commands SetAccessPoint and SetArea, the value must be set to true." + }, + { + "use": "optional", + "name": "AccessPointManagementSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false", + "description": "Indicates that the client can perform CRUD operations (create, read, update and delete)\n\t\t\t\t\t\t\ton access points. To enable the use of the commands GetAccessPoints, GetAccessPointList,\n\t\t\t\t\t\t\tCreateAccessPoint, ModifyAccessPoint, DeleteAccessPoint, SetAccessPointAuthenticationProfile\n\t\t\t\t\t\t\tand DeleteAccessPointAuthenticationProfile, the value must be set to true." + }, + { + "use": "optional", + "name": "AreaManagementSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false", + "description": "Indicates that the client can perform CRUD operations (create, read, update and delete)\n\t\t\t\t\t\t\ton areas. To enable the use of the commands GetAreas, GetAreaList, CreateArea, ModifyArea\n\t\t\t\t\t\t\tand DeleteArea, the value must be set to true." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capability response message contains the requested Access Control\n\t\t\t\t\t\t\t\t\tservice capabilities using a hierarchical XML capability structure." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "GetAccessPointInfo", + "port_type": "PACSPort", + "description": "This operation requests a list of AccessPointInfo items matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointInfoRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointInfo", + "schema": { + "name": "GetAccessPointInfo", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of AccessPointInfo items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointInfoResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointInfoResponse", + "schema": { + "name": "GetAccessPointInfoResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AccessPointInfo", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfo", + "type_name": "AccessPointInfo", + "definition": { + "kind": "complexType", + "name": "AccessPointInfo", + "description": "The AccessPointInfo structure contains basic information about an access point instance. \n\t\t\t\t\t\tAn access point defines an entity a credential can be granted or denied access to. \n\t\t\t\t\t\tThe AccessPointInfo structure provides basic information on how access is controlled \n\t\t\t\t\t\tin one direction for a door (from which area to which area).\n\t\t\t\t\t\tMultiple access points may cover the same door. A typical case is one access point for \n\t\t\t\t\t\tentry and another for exit, both referencing the same door.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AccessPointInfoBase", + "description": "Used as extension base for AccessPointInfo.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable description for the AccessPoint. It shall\n\t\t\t\t\t\t\t\t\t\tbe up to 1024 characters." + }, + { + "name": "AreaFrom", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area from which access is requested." + }, + { + "name": "AreaTo", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area to which access is requested." + }, + { + "name": "EntityType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional entity type; if missing, a Door type as defined by [ONVIF Door Control \n\t\t\t\t\t\t\t\t\t\tService Specification] should be assumed. This can also be represented by the \n\t\t\t\t\t\t\t\t\t\tQName value \"tdc:Door\" – where tdc is the namespace of the door control service:\n\t\t\t\t\t\t\t\t\t\t\"http://www.onvif.org/ver10/doorcontrol/wsdl\". This field is provided for future \n\t\t\t\t\t\t\t\t\t\textensions; it will allow an access point being extended to cover entity types \n\t\t\t\t\t\t\t\t\t\tother than doors as well." + }, + { + "name": "Entity", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the entity used to control access; the entity type\n\t\t\t\t\t\t\t\t\t\tmay be specified by the optional EntityType field explained below but is\n\t\t\t\t\t\t\t\t\t\ttypically a Door." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointCapabilities", + "type_name": "AccessPointCapabilities", + "definition": { + "kind": "complexType", + "name": "AccessPointCapabilities", + "description": "The AccessPoint capabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent AccessPoint instances may have different set of capabilities. This information may\n\t\t\t\t\t\tchange during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [ + { + "name": "SupportedSecurityLevels", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of security level tokens that this access point supports.\n\t\t\t\t\t\t\t\tSee [Authentication Behavior Service Specification].\n\t\t\t\t\t\t\t\tThis field is optional, and if omitted, the device cannot support multi-factor\n\t\t\t\t\t\t\t\tauthentication for this access point.\n\t\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported\n\t\t\t\t\t\t\t\tsecurity levels are replaced with the new list." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SupportedSecurityLevelsExtension", + "type_name": "SupportedSecurityLevelsExtension", + "definition": { + "kind": "complexType", + "name": "SupportedSecurityLevelsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "DisableAccessPoint", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports EnableAccessPoint\n\t\t\t\t\t\t\tand DisableAccessPoint commands." + }, + { + "use": "optional", + "name": "Duress", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of duress events." + }, + { + "use": "optional", + "name": "AnonymousAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint has a REX switch or other input that\n\t\t\t\t\t\t\tallows anonymous access." + }, + { + "use": "optional", + "name": "AccessTaken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of\n\t\t\t\t\t\t\tAccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it\n\t\t\t\t\t\t\tindicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported." + }, + { + "use": "optional", + "name": "ExternalAuthorization", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports the\n\t\t\t\t\t\t\tExternalAuthorization operation and the generation of Request events. If AnonymousAccess and\n\t\t\t\t\t\t\tExternalAuthorization are both true, it indicates that the Anonymous version is supported as\n\t\t\t\t\t\t\twell." + }, + { + "use": "optional", + "name": "SupportedRecognitionTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "A list of recognition types that the device supports. This field is only relevant for devices\n\t\t\t\t\t\t\tthat are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]).\n\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported recognition types\n\t\t\t\t\t\t\tare replaced with the new list.\n\t\t\t\t\t\t\tRecognition types starting with the prefix pt: are reserved to define ONVIF-specific\n\t\t\t\t\t\t\ttypes as defined in pt:RecognitionType. For custom defined identifier types, free text \n\t\t\t\t\t\t\tcan be used." + }, + { + "use": "optional", + "name": "IdentifierAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this access point supports the AccessControl/Request/Identifier\n\t\t\t\t\t\t\tevent to request external authorization.\n\t\t\t\t\t\t\tIdentfier access requires that ExternalAuthorization is set to true.\n\t\t\t\t\t\t\tThe IdentifierAccess capability is typically enabled for devices that do not have any \n\t\t\t\t\t\t\tknowledge of credential tokens. When IdentifierAccess is set to true then the device \n\t\t\t\t\t\t\tmust support the identifier events." + }, + { + "use": "optional", + "name": "SupportedFeedbackTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported feedback types. Feedback types starting with the prefix pt:\n\t\t\t\t\t\t\tare reserved to define ONVIF-specific types as defined in tac:FeedbackType.\n\t\t\t\t\t\t\tFor custom defined feedback types, free text can be used." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the AccessPoint." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of AccessPointInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "GetAccessPointInfoList", + "port_type": "PACSPort", + "description": "This operation requests a list of all AccessPointInfo items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer to section 4.8.3 in [ONVIF PACS Architecture and Design Considerations] for more details. The number of items returned shall not be greater than the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointInfoListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointInfoList", + "schema": { + "name": "GetAccessPointInfoList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is determined by the\n\t\t\t\t\t\t\t\t\tdevice." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointInfoListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointInfoListResponse", + "schema": { + "name": "GetAccessPointInfoListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "AccessPointInfo", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfo", + "type_name": "AccessPointInfo", + "definition": { + "kind": "complexType", + "name": "AccessPointInfo", + "description": "The AccessPointInfo structure contains basic information about an access point instance. \n\t\t\t\t\t\tAn access point defines an entity a credential can be granted or denied access to. \n\t\t\t\t\t\tThe AccessPointInfo structure provides basic information on how access is controlled \n\t\t\t\t\t\tin one direction for a door (from which area to which area).\n\t\t\t\t\t\tMultiple access points may cover the same door. A typical case is one access point for \n\t\t\t\t\t\tentry and another for exit, both referencing the same door.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AccessPointInfoBase", + "description": "Used as extension base for AccessPointInfo.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable description for the AccessPoint. It shall\n\t\t\t\t\t\t\t\t\t\tbe up to 1024 characters." + }, + { + "name": "AreaFrom", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area from which access is requested." + }, + { + "name": "AreaTo", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area to which access is requested." + }, + { + "name": "EntityType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional entity type; if missing, a Door type as defined by [ONVIF Door Control \n\t\t\t\t\t\t\t\t\t\tService Specification] should be assumed. This can also be represented by the \n\t\t\t\t\t\t\t\t\t\tQName value \"tdc:Door\" – where tdc is the namespace of the door control service:\n\t\t\t\t\t\t\t\t\t\t\"http://www.onvif.org/ver10/doorcontrol/wsdl\". This field is provided for future \n\t\t\t\t\t\t\t\t\t\textensions; it will allow an access point being extended to cover entity types \n\t\t\t\t\t\t\t\t\t\tother than doors as well." + }, + { + "name": "Entity", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the entity used to control access; the entity type\n\t\t\t\t\t\t\t\t\t\tmay be specified by the optional EntityType field explained below but is\n\t\t\t\t\t\t\t\t\t\ttypically a Door." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointCapabilities", + "type_name": "AccessPointCapabilities", + "definition": { + "kind": "complexType", + "name": "AccessPointCapabilities", + "description": "The AccessPoint capabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent AccessPoint instances may have different set of capabilities. This information may\n\t\t\t\t\t\tchange during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [ + { + "name": "SupportedSecurityLevels", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of security level tokens that this access point supports.\n\t\t\t\t\t\t\t\tSee [Authentication Behavior Service Specification].\n\t\t\t\t\t\t\t\tThis field is optional, and if omitted, the device cannot support multi-factor\n\t\t\t\t\t\t\t\tauthentication for this access point.\n\t\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported\n\t\t\t\t\t\t\t\tsecurity levels are replaced with the new list." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SupportedSecurityLevelsExtension", + "type_name": "SupportedSecurityLevelsExtension", + "definition": { + "kind": "complexType", + "name": "SupportedSecurityLevelsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "DisableAccessPoint", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports EnableAccessPoint\n\t\t\t\t\t\t\tand DisableAccessPoint commands." + }, + { + "use": "optional", + "name": "Duress", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of duress events." + }, + { + "use": "optional", + "name": "AnonymousAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint has a REX switch or other input that\n\t\t\t\t\t\t\tallows anonymous access." + }, + { + "use": "optional", + "name": "AccessTaken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of\n\t\t\t\t\t\t\tAccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it\n\t\t\t\t\t\t\tindicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported." + }, + { + "use": "optional", + "name": "ExternalAuthorization", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports the\n\t\t\t\t\t\t\tExternalAuthorization operation and the generation of Request events. If AnonymousAccess and\n\t\t\t\t\t\t\tExternalAuthorization are both true, it indicates that the Anonymous version is supported as\n\t\t\t\t\t\t\twell." + }, + { + "use": "optional", + "name": "SupportedRecognitionTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "A list of recognition types that the device supports. This field is only relevant for devices\n\t\t\t\t\t\t\tthat are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]).\n\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported recognition types\n\t\t\t\t\t\t\tare replaced with the new list.\n\t\t\t\t\t\t\tRecognition types starting with the prefix pt: are reserved to define ONVIF-specific\n\t\t\t\t\t\t\ttypes as defined in pt:RecognitionType. For custom defined identifier types, free text \n\t\t\t\t\t\t\tcan be used." + }, + { + "use": "optional", + "name": "IdentifierAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this access point supports the AccessControl/Request/Identifier\n\t\t\t\t\t\t\tevent to request external authorization.\n\t\t\t\t\t\t\tIdentfier access requires that ExternalAuthorization is set to true.\n\t\t\t\t\t\t\tThe IdentifierAccess capability is typically enabled for devices that do not have any \n\t\t\t\t\t\t\tknowledge of credential tokens. When IdentifierAccess is set to true then the device \n\t\t\t\t\t\t\tmust support the identifier events." + }, + { + "use": "optional", + "name": "SupportedFeedbackTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported feedback types. Feedback types starting with the prefix pt:\n\t\t\t\t\t\t\tare reserved to define ONVIF-specific types as defined in tac:FeedbackType.\n\t\t\t\t\t\t\tFor custom defined feedback types, free text can be used." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the AccessPoint." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of AccessPointInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "GetAccessPoints", + "port_type": "PACSPort", + "description": "This operation requests a list of AccessPoint items matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPoints", + "schema": { + "name": "GetAccessPoints", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of AccessPoint items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointsResponse", + "schema": { + "name": "GetAccessPointsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AccessPoint", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPoint", + "type_name": "AccessPoint", + "definition": { + "kind": "complexType", + "name": "AccessPoint", + "description": "The AccessPoint structure shall include all properties of the AccessPointInfo structure,\n\t\t\t\t\t\ta reference to an authentication profile instance, and optionally a number of input and output devices.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfo", + "base_definition": { + "kind": "complexType", + "name": "AccessPointInfo", + "description": "The AccessPointInfo structure contains basic information about an access point instance. \n\t\t\t\t\t\tAn access point defines an entity a credential can be granted or denied access to. \n\t\t\t\t\t\tThe AccessPointInfo structure provides basic information on how access is controlled \n\t\t\t\t\t\tin one direction for a door (from which area to which area).\n\t\t\t\t\t\tMultiple access points may cover the same door. A typical case is one access point for \n\t\t\t\t\t\tentry and another for exit, both referencing the same door.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AccessPointInfoBase", + "description": "Used as extension base for AccessPointInfo.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable description for the AccessPoint. It shall\n\t\t\t\t\t\t\t\t\t\tbe up to 1024 characters." + }, + { + "name": "AreaFrom", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area from which access is requested." + }, + { + "name": "AreaTo", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area to which access is requested." + }, + { + "name": "EntityType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional entity type; if missing, a Door type as defined by [ONVIF Door Control \n\t\t\t\t\t\t\t\t\t\tService Specification] should be assumed. This can also be represented by the \n\t\t\t\t\t\t\t\t\t\tQName value \"tdc:Door\" – where tdc is the namespace of the door control service:\n\t\t\t\t\t\t\t\t\t\t\"http://www.onvif.org/ver10/doorcontrol/wsdl\". This field is provided for future \n\t\t\t\t\t\t\t\t\t\textensions; it will allow an access point being extended to cover entity types \n\t\t\t\t\t\t\t\t\t\tother than doors as well." + }, + { + "name": "Entity", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the entity used to control access; the entity type\n\t\t\t\t\t\t\t\t\t\tmay be specified by the optional EntityType field explained below but is\n\t\t\t\t\t\t\t\t\t\ttypically a Door." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointCapabilities", + "type_name": "AccessPointCapabilities", + "definition": { + "kind": "complexType", + "name": "AccessPointCapabilities", + "description": "The AccessPoint capabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent AccessPoint instances may have different set of capabilities. This information may\n\t\t\t\t\t\tchange during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [ + { + "name": "SupportedSecurityLevels", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of security level tokens that this access point supports.\n\t\t\t\t\t\t\t\tSee [Authentication Behavior Service Specification].\n\t\t\t\t\t\t\t\tThis field is optional, and if omitted, the device cannot support multi-factor\n\t\t\t\t\t\t\t\tauthentication for this access point.\n\t\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported\n\t\t\t\t\t\t\t\tsecurity levels are replaced with the new list." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SupportedSecurityLevelsExtension", + "type_name": "SupportedSecurityLevelsExtension", + "definition": { + "kind": "complexType", + "name": "SupportedSecurityLevelsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "DisableAccessPoint", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports EnableAccessPoint\n\t\t\t\t\t\t\tand DisableAccessPoint commands." + }, + { + "use": "optional", + "name": "Duress", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of duress events." + }, + { + "use": "optional", + "name": "AnonymousAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint has a REX switch or other input that\n\t\t\t\t\t\t\tallows anonymous access." + }, + { + "use": "optional", + "name": "AccessTaken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of\n\t\t\t\t\t\t\tAccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it\n\t\t\t\t\t\t\tindicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported." + }, + { + "use": "optional", + "name": "ExternalAuthorization", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports the\n\t\t\t\t\t\t\tExternalAuthorization operation and the generation of Request events. If AnonymousAccess and\n\t\t\t\t\t\t\tExternalAuthorization are both true, it indicates that the Anonymous version is supported as\n\t\t\t\t\t\t\twell." + }, + { + "use": "optional", + "name": "SupportedRecognitionTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "A list of recognition types that the device supports. This field is only relevant for devices\n\t\t\t\t\t\t\tthat are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]).\n\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported recognition types\n\t\t\t\t\t\t\tare replaced with the new list.\n\t\t\t\t\t\t\tRecognition types starting with the prefix pt: are reserved to define ONVIF-specific\n\t\t\t\t\t\t\ttypes as defined in pt:RecognitionType. For custom defined identifier types, free text \n\t\t\t\t\t\t\tcan be used." + }, + { + "use": "optional", + "name": "IdentifierAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this access point supports the AccessControl/Request/Identifier\n\t\t\t\t\t\t\tevent to request external authorization.\n\t\t\t\t\t\t\tIdentfier access requires that ExternalAuthorization is set to true.\n\t\t\t\t\t\t\tThe IdentifierAccess capability is typically enabled for devices that do not have any \n\t\t\t\t\t\t\tknowledge of credential tokens. When IdentifierAccess is set to true then the device \n\t\t\t\t\t\t\tmust support the identifier events." + }, + { + "use": "optional", + "name": "SupportedFeedbackTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported feedback types. Feedback types starting with the prefix pt:\n\t\t\t\t\t\t\tare reserved to define ONVIF-specific types as defined in tac:FeedbackType.\n\t\t\t\t\t\t\tFor custom defined feedback types, free text can be used." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the AccessPoint." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "AuthenticationProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A reference to an authentication profile which defines the authentication\n\t\t\t\t\t\t\t\t\t\tbehavior of the access point." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointExtension", + "type_name": "AccessPointExtension", + "definition": { + "kind": "complexType", + "name": "AccessPointExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of AccessPoint items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "GetAccessPointList", + "port_type": "PACSPort", + "description": "This operation requests a list of all AccessPoint items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. The number of items returned shall not be greater than the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointList", + "schema": { + "name": "GetAccessPointList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is determined by the\n\t\t\t\t\t\t\t\t\tdevice." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointListResponse", + "schema": { + "name": "GetAccessPointListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "AccessPoint", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPoint", + "type_name": "AccessPoint", + "definition": { + "kind": "complexType", + "name": "AccessPoint", + "description": "The AccessPoint structure shall include all properties of the AccessPointInfo structure,\n\t\t\t\t\t\ta reference to an authentication profile instance, and optionally a number of input and output devices.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfo", + "base_definition": { + "kind": "complexType", + "name": "AccessPointInfo", + "description": "The AccessPointInfo structure contains basic information about an access point instance. \n\t\t\t\t\t\tAn access point defines an entity a credential can be granted or denied access to. \n\t\t\t\t\t\tThe AccessPointInfo structure provides basic information on how access is controlled \n\t\t\t\t\t\tin one direction for a door (from which area to which area).\n\t\t\t\t\t\tMultiple access points may cover the same door. A typical case is one access point for \n\t\t\t\t\t\tentry and another for exit, both referencing the same door.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AccessPointInfoBase", + "description": "Used as extension base for AccessPointInfo.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable description for the AccessPoint. It shall\n\t\t\t\t\t\t\t\t\t\tbe up to 1024 characters." + }, + { + "name": "AreaFrom", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area from which access is requested." + }, + { + "name": "AreaTo", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area to which access is requested." + }, + { + "name": "EntityType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional entity type; if missing, a Door type as defined by [ONVIF Door Control \n\t\t\t\t\t\t\t\t\t\tService Specification] should be assumed. This can also be represented by the \n\t\t\t\t\t\t\t\t\t\tQName value \"tdc:Door\" – where tdc is the namespace of the door control service:\n\t\t\t\t\t\t\t\t\t\t\"http://www.onvif.org/ver10/doorcontrol/wsdl\". This field is provided for future \n\t\t\t\t\t\t\t\t\t\textensions; it will allow an access point being extended to cover entity types \n\t\t\t\t\t\t\t\t\t\tother than doors as well." + }, + { + "name": "Entity", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the entity used to control access; the entity type\n\t\t\t\t\t\t\t\t\t\tmay be specified by the optional EntityType field explained below but is\n\t\t\t\t\t\t\t\t\t\ttypically a Door." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointCapabilities", + "type_name": "AccessPointCapabilities", + "definition": { + "kind": "complexType", + "name": "AccessPointCapabilities", + "description": "The AccessPoint capabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent AccessPoint instances may have different set of capabilities. This information may\n\t\t\t\t\t\tchange during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [ + { + "name": "SupportedSecurityLevels", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of security level tokens that this access point supports.\n\t\t\t\t\t\t\t\tSee [Authentication Behavior Service Specification].\n\t\t\t\t\t\t\t\tThis field is optional, and if omitted, the device cannot support multi-factor\n\t\t\t\t\t\t\t\tauthentication for this access point.\n\t\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported\n\t\t\t\t\t\t\t\tsecurity levels are replaced with the new list." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SupportedSecurityLevelsExtension", + "type_name": "SupportedSecurityLevelsExtension", + "definition": { + "kind": "complexType", + "name": "SupportedSecurityLevelsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "DisableAccessPoint", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports EnableAccessPoint\n\t\t\t\t\t\t\tand DisableAccessPoint commands." + }, + { + "use": "optional", + "name": "Duress", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of duress events." + }, + { + "use": "optional", + "name": "AnonymousAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint has a REX switch or other input that\n\t\t\t\t\t\t\tallows anonymous access." + }, + { + "use": "optional", + "name": "AccessTaken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of\n\t\t\t\t\t\t\tAccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it\n\t\t\t\t\t\t\tindicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported." + }, + { + "use": "optional", + "name": "ExternalAuthorization", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports the\n\t\t\t\t\t\t\tExternalAuthorization operation and the generation of Request events. If AnonymousAccess and\n\t\t\t\t\t\t\tExternalAuthorization are both true, it indicates that the Anonymous version is supported as\n\t\t\t\t\t\t\twell." + }, + { + "use": "optional", + "name": "SupportedRecognitionTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "A list of recognition types that the device supports. This field is only relevant for devices\n\t\t\t\t\t\t\tthat are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]).\n\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported recognition types\n\t\t\t\t\t\t\tare replaced with the new list.\n\t\t\t\t\t\t\tRecognition types starting with the prefix pt: are reserved to define ONVIF-specific\n\t\t\t\t\t\t\ttypes as defined in pt:RecognitionType. For custom defined identifier types, free text \n\t\t\t\t\t\t\tcan be used." + }, + { + "use": "optional", + "name": "IdentifierAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this access point supports the AccessControl/Request/Identifier\n\t\t\t\t\t\t\tevent to request external authorization.\n\t\t\t\t\t\t\tIdentfier access requires that ExternalAuthorization is set to true.\n\t\t\t\t\t\t\tThe IdentifierAccess capability is typically enabled for devices that do not have any \n\t\t\t\t\t\t\tknowledge of credential tokens. When IdentifierAccess is set to true then the device \n\t\t\t\t\t\t\tmust support the identifier events." + }, + { + "use": "optional", + "name": "SupportedFeedbackTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported feedback types. Feedback types starting with the prefix pt:\n\t\t\t\t\t\t\tare reserved to define ONVIF-specific types as defined in tac:FeedbackType.\n\t\t\t\t\t\t\tFor custom defined feedback types, free text can be used." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the AccessPoint." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "AuthenticationProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A reference to an authentication profile which defines the authentication\n\t\t\t\t\t\t\t\t\t\tbehavior of the access point." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointExtension", + "type_name": "AccessPointExtension", + "definition": { + "kind": "complexType", + "name": "AccessPointExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of AccessPoint items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "CreateAccessPoint", + "port_type": "PACSPort", + "description": "This operation creates the specified access point in the device. The token field of the AccessPoint structure shall be empty and the device shall allocate a token for the access point. The allocated token shall be returned in the response. If the client sends any value in the token field, the device shall return InvalidArgVal as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}CreateAccessPointRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}CreateAccessPoint", + "schema": { + "name": "CreateAccessPoint", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AccessPoint", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPoint", + "type_name": "AccessPoint", + "definition": { + "kind": "complexType", + "name": "AccessPoint", + "description": "The AccessPoint structure shall include all properties of the AccessPointInfo structure,\n\t\t\t\t\t\ta reference to an authentication profile instance, and optionally a number of input and output devices.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfo", + "base_definition": { + "kind": "complexType", + "name": "AccessPointInfo", + "description": "The AccessPointInfo structure contains basic information about an access point instance. \n\t\t\t\t\t\tAn access point defines an entity a credential can be granted or denied access to. \n\t\t\t\t\t\tThe AccessPointInfo structure provides basic information on how access is controlled \n\t\t\t\t\t\tin one direction for a door (from which area to which area).\n\t\t\t\t\t\tMultiple access points may cover the same door. A typical case is one access point for \n\t\t\t\t\t\tentry and another for exit, both referencing the same door.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AccessPointInfoBase", + "description": "Used as extension base for AccessPointInfo.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable description for the AccessPoint. It shall\n\t\t\t\t\t\t\t\t\t\tbe up to 1024 characters." + }, + { + "name": "AreaFrom", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area from which access is requested." + }, + { + "name": "AreaTo", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area to which access is requested." + }, + { + "name": "EntityType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional entity type; if missing, a Door type as defined by [ONVIF Door Control \n\t\t\t\t\t\t\t\t\t\tService Specification] should be assumed. This can also be represented by the \n\t\t\t\t\t\t\t\t\t\tQName value \"tdc:Door\" – where tdc is the namespace of the door control service:\n\t\t\t\t\t\t\t\t\t\t\"http://www.onvif.org/ver10/doorcontrol/wsdl\". This field is provided for future \n\t\t\t\t\t\t\t\t\t\textensions; it will allow an access point being extended to cover entity types \n\t\t\t\t\t\t\t\t\t\tother than doors as well." + }, + { + "name": "Entity", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the entity used to control access; the entity type\n\t\t\t\t\t\t\t\t\t\tmay be specified by the optional EntityType field explained below but is\n\t\t\t\t\t\t\t\t\t\ttypically a Door." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointCapabilities", + "type_name": "AccessPointCapabilities", + "definition": { + "kind": "complexType", + "name": "AccessPointCapabilities", + "description": "The AccessPoint capabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent AccessPoint instances may have different set of capabilities. This information may\n\t\t\t\t\t\tchange during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [ + { + "name": "SupportedSecurityLevels", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of security level tokens that this access point supports.\n\t\t\t\t\t\t\t\tSee [Authentication Behavior Service Specification].\n\t\t\t\t\t\t\t\tThis field is optional, and if omitted, the device cannot support multi-factor\n\t\t\t\t\t\t\t\tauthentication for this access point.\n\t\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported\n\t\t\t\t\t\t\t\tsecurity levels are replaced with the new list." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SupportedSecurityLevelsExtension", + "type_name": "SupportedSecurityLevelsExtension", + "definition": { + "kind": "complexType", + "name": "SupportedSecurityLevelsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "DisableAccessPoint", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports EnableAccessPoint\n\t\t\t\t\t\t\tand DisableAccessPoint commands." + }, + { + "use": "optional", + "name": "Duress", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of duress events." + }, + { + "use": "optional", + "name": "AnonymousAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint has a REX switch or other input that\n\t\t\t\t\t\t\tallows anonymous access." + }, + { + "use": "optional", + "name": "AccessTaken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of\n\t\t\t\t\t\t\tAccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it\n\t\t\t\t\t\t\tindicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported." + }, + { + "use": "optional", + "name": "ExternalAuthorization", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports the\n\t\t\t\t\t\t\tExternalAuthorization operation and the generation of Request events. If AnonymousAccess and\n\t\t\t\t\t\t\tExternalAuthorization are both true, it indicates that the Anonymous version is supported as\n\t\t\t\t\t\t\twell." + }, + { + "use": "optional", + "name": "SupportedRecognitionTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "A list of recognition types that the device supports. This field is only relevant for devices\n\t\t\t\t\t\t\tthat are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]).\n\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported recognition types\n\t\t\t\t\t\t\tare replaced with the new list.\n\t\t\t\t\t\t\tRecognition types starting with the prefix pt: are reserved to define ONVIF-specific\n\t\t\t\t\t\t\ttypes as defined in pt:RecognitionType. For custom defined identifier types, free text \n\t\t\t\t\t\t\tcan be used." + }, + { + "use": "optional", + "name": "IdentifierAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this access point supports the AccessControl/Request/Identifier\n\t\t\t\t\t\t\tevent to request external authorization.\n\t\t\t\t\t\t\tIdentfier access requires that ExternalAuthorization is set to true.\n\t\t\t\t\t\t\tThe IdentifierAccess capability is typically enabled for devices that do not have any \n\t\t\t\t\t\t\tknowledge of credential tokens. When IdentifierAccess is set to true then the device \n\t\t\t\t\t\t\tmust support the identifier events." + }, + { + "use": "optional", + "name": "SupportedFeedbackTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported feedback types. Feedback types starting with the prefix pt:\n\t\t\t\t\t\t\tare reserved to define ONVIF-specific types as defined in tac:FeedbackType.\n\t\t\t\t\t\t\tFor custom defined feedback types, free text can be used." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the AccessPoint." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "AuthenticationProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A reference to an authentication profile which defines the authentication\n\t\t\t\t\t\t\t\t\t\tbehavior of the access point." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointExtension", + "type_name": "AccessPointExtension", + "definition": { + "kind": "complexType", + "name": "AccessPointExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "AccessPoint item to create" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}CreateAccessPointResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}CreateAccessPointResponse", + "schema": { + "name": "CreateAccessPointResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of created AccessPoint item" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "SetAccessPoint", + "port_type": "PACSPort", + "description": "This method is used to synchronize an access point in a client with the device. If an access point with the specified token does not exist in the device, the access point is created. If an access point with the specified token exists, then the access point is modified. A call to this method takes an AccessPoint structure as input parameter. The token field of the AccessPoint structure shall not be empty. A device that signals support for the ClientSuppliedTokenSupported capability shall implement this command. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SetAccessPointRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SetAccessPoint", + "schema": { + "name": "SetAccessPoint", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AccessPoint", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPoint", + "type_name": "AccessPoint", + "definition": { + "kind": "complexType", + "name": "AccessPoint", + "description": "The AccessPoint structure shall include all properties of the AccessPointInfo structure,\n\t\t\t\t\t\ta reference to an authentication profile instance, and optionally a number of input and output devices.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfo", + "base_definition": { + "kind": "complexType", + "name": "AccessPointInfo", + "description": "The AccessPointInfo structure contains basic information about an access point instance. \n\t\t\t\t\t\tAn access point defines an entity a credential can be granted or denied access to. \n\t\t\t\t\t\tThe AccessPointInfo structure provides basic information on how access is controlled \n\t\t\t\t\t\tin one direction for a door (from which area to which area).\n\t\t\t\t\t\tMultiple access points may cover the same door. A typical case is one access point for \n\t\t\t\t\t\tentry and another for exit, both referencing the same door.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AccessPointInfoBase", + "description": "Used as extension base for AccessPointInfo.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable description for the AccessPoint. It shall\n\t\t\t\t\t\t\t\t\t\tbe up to 1024 characters." + }, + { + "name": "AreaFrom", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area from which access is requested." + }, + { + "name": "AreaTo", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area to which access is requested." + }, + { + "name": "EntityType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional entity type; if missing, a Door type as defined by [ONVIF Door Control \n\t\t\t\t\t\t\t\t\t\tService Specification] should be assumed. This can also be represented by the \n\t\t\t\t\t\t\t\t\t\tQName value \"tdc:Door\" – where tdc is the namespace of the door control service:\n\t\t\t\t\t\t\t\t\t\t\"http://www.onvif.org/ver10/doorcontrol/wsdl\". This field is provided for future \n\t\t\t\t\t\t\t\t\t\textensions; it will allow an access point being extended to cover entity types \n\t\t\t\t\t\t\t\t\t\tother than doors as well." + }, + { + "name": "Entity", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the entity used to control access; the entity type\n\t\t\t\t\t\t\t\t\t\tmay be specified by the optional EntityType field explained below but is\n\t\t\t\t\t\t\t\t\t\ttypically a Door." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointCapabilities", + "type_name": "AccessPointCapabilities", + "definition": { + "kind": "complexType", + "name": "AccessPointCapabilities", + "description": "The AccessPoint capabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent AccessPoint instances may have different set of capabilities. This information may\n\t\t\t\t\t\tchange during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [ + { + "name": "SupportedSecurityLevels", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of security level tokens that this access point supports.\n\t\t\t\t\t\t\t\tSee [Authentication Behavior Service Specification].\n\t\t\t\t\t\t\t\tThis field is optional, and if omitted, the device cannot support multi-factor\n\t\t\t\t\t\t\t\tauthentication for this access point.\n\t\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported\n\t\t\t\t\t\t\t\tsecurity levels are replaced with the new list." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SupportedSecurityLevelsExtension", + "type_name": "SupportedSecurityLevelsExtension", + "definition": { + "kind": "complexType", + "name": "SupportedSecurityLevelsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "DisableAccessPoint", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports EnableAccessPoint\n\t\t\t\t\t\t\tand DisableAccessPoint commands." + }, + { + "use": "optional", + "name": "Duress", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of duress events." + }, + { + "use": "optional", + "name": "AnonymousAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint has a REX switch or other input that\n\t\t\t\t\t\t\tallows anonymous access." + }, + { + "use": "optional", + "name": "AccessTaken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of\n\t\t\t\t\t\t\tAccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it\n\t\t\t\t\t\t\tindicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported." + }, + { + "use": "optional", + "name": "ExternalAuthorization", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports the\n\t\t\t\t\t\t\tExternalAuthorization operation and the generation of Request events. If AnonymousAccess and\n\t\t\t\t\t\t\tExternalAuthorization are both true, it indicates that the Anonymous version is supported as\n\t\t\t\t\t\t\twell." + }, + { + "use": "optional", + "name": "SupportedRecognitionTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "A list of recognition types that the device supports. This field is only relevant for devices\n\t\t\t\t\t\t\tthat are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]).\n\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported recognition types\n\t\t\t\t\t\t\tare replaced with the new list.\n\t\t\t\t\t\t\tRecognition types starting with the prefix pt: are reserved to define ONVIF-specific\n\t\t\t\t\t\t\ttypes as defined in pt:RecognitionType. For custom defined identifier types, free text \n\t\t\t\t\t\t\tcan be used." + }, + { + "use": "optional", + "name": "IdentifierAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this access point supports the AccessControl/Request/Identifier\n\t\t\t\t\t\t\tevent to request external authorization.\n\t\t\t\t\t\t\tIdentfier access requires that ExternalAuthorization is set to true.\n\t\t\t\t\t\t\tThe IdentifierAccess capability is typically enabled for devices that do not have any \n\t\t\t\t\t\t\tknowledge of credential tokens. When IdentifierAccess is set to true then the device \n\t\t\t\t\t\t\tmust support the identifier events." + }, + { + "use": "optional", + "name": "SupportedFeedbackTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported feedback types. Feedback types starting with the prefix pt:\n\t\t\t\t\t\t\tare reserved to define ONVIF-specific types as defined in tac:FeedbackType.\n\t\t\t\t\t\t\tFor custom defined feedback types, free text can be used." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the AccessPoint." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "AuthenticationProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A reference to an authentication profile which defines the authentication\n\t\t\t\t\t\t\t\t\t\tbehavior of the access point." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointExtension", + "type_name": "AccessPointExtension", + "definition": { + "kind": "complexType", + "name": "AccessPointExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "AccessPoint item to create or modify" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SetAccessPointResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SetAccessPointResponse", + "schema": { + "name": "SetAccessPointResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "ModifyAccessPoint", + "port_type": "PACSPort", + "description": "This operation modifies the specified access point. The token of the access point to modify is specified in the token field of the AccessPoint structure and shall not be empty. All other fields in the structure shall overwrite the fields in the specified access point. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}ModifyAccessPointRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}ModifyAccessPoint", + "schema": { + "name": "ModifyAccessPoint", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AccessPoint", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPoint", + "type_name": "AccessPoint", + "definition": { + "kind": "complexType", + "name": "AccessPoint", + "description": "The AccessPoint structure shall include all properties of the AccessPointInfo structure,\n\t\t\t\t\t\ta reference to an authentication profile instance, and optionally a number of input and output devices.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfo", + "base_definition": { + "kind": "complexType", + "name": "AccessPointInfo", + "description": "The AccessPointInfo structure contains basic information about an access point instance. \n\t\t\t\t\t\tAn access point defines an entity a credential can be granted or denied access to. \n\t\t\t\t\t\tThe AccessPointInfo structure provides basic information on how access is controlled \n\t\t\t\t\t\tin one direction for a door (from which area to which area).\n\t\t\t\t\t\tMultiple access points may cover the same door. A typical case is one access point for \n\t\t\t\t\t\tentry and another for exit, both referencing the same door.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AccessPointInfoBase", + "description": "Used as extension base for AccessPointInfo.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable description for the AccessPoint. It shall\n\t\t\t\t\t\t\t\t\t\tbe up to 1024 characters." + }, + { + "name": "AreaFrom", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area from which access is requested." + }, + { + "name": "AreaTo", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to the Area to which access is requested." + }, + { + "name": "EntityType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional entity type; if missing, a Door type as defined by [ONVIF Door Control \n\t\t\t\t\t\t\t\t\t\tService Specification] should be assumed. This can also be represented by the \n\t\t\t\t\t\t\t\t\t\tQName value \"tdc:Door\" – where tdc is the namespace of the door control service:\n\t\t\t\t\t\t\t\t\t\t\"http://www.onvif.org/ver10/doorcontrol/wsdl\". This field is provided for future \n\t\t\t\t\t\t\t\t\t\textensions; it will allow an access point being extended to cover entity types \n\t\t\t\t\t\t\t\t\t\tother than doors as well." + }, + { + "name": "Entity", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the entity used to control access; the entity type\n\t\t\t\t\t\t\t\t\t\tmay be specified by the optional EntityType field explained below but is\n\t\t\t\t\t\t\t\t\t\ttypically a Door." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointCapabilities", + "type_name": "AccessPointCapabilities", + "definition": { + "kind": "complexType", + "name": "AccessPointCapabilities", + "description": "The AccessPoint capabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent AccessPoint instances may have different set of capabilities. This information may\n\t\t\t\t\t\tchange during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [ + { + "name": "SupportedSecurityLevels", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of security level tokens that this access point supports.\n\t\t\t\t\t\t\t\tSee [Authentication Behavior Service Specification].\n\t\t\t\t\t\t\t\tThis field is optional, and if omitted, the device cannot support multi-factor\n\t\t\t\t\t\t\t\tauthentication for this access point.\n\t\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported\n\t\t\t\t\t\t\t\tsecurity levels are replaced with the new list." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SupportedSecurityLevelsExtension", + "type_name": "SupportedSecurityLevelsExtension", + "definition": { + "kind": "complexType", + "name": "SupportedSecurityLevelsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "DisableAccessPoint", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports EnableAccessPoint\n\t\t\t\t\t\t\tand DisableAccessPoint commands." + }, + { + "use": "optional", + "name": "Duress", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of duress events." + }, + { + "use": "optional", + "name": "AnonymousAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint has a REX switch or other input that\n\t\t\t\t\t\t\tallows anonymous access." + }, + { + "use": "optional", + "name": "AccessTaken", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports generation of\n\t\t\t\t\t\t\tAccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it\n\t\t\t\t\t\t\tindicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported." + }, + { + "use": "optional", + "name": "ExternalAuthorization", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this AccessPoint instance supports the\n\t\t\t\t\t\t\tExternalAuthorization operation and the generation of Request events. If AnonymousAccess and\n\t\t\t\t\t\t\tExternalAuthorization are both true, it indicates that the Anonymous version is supported as\n\t\t\t\t\t\t\twell." + }, + { + "use": "optional", + "name": "SupportedRecognitionTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "A list of recognition types that the device supports. This field is only relevant for devices\n\t\t\t\t\t\t\tthat are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]).\n\t\t\t\t\t\t\tPlease note that when an access point is updated, then any previously supported recognition types\n\t\t\t\t\t\t\tare replaced with the new list.\n\t\t\t\t\t\t\tRecognition types starting with the prefix pt: are reserved to define ONVIF-specific\n\t\t\t\t\t\t\ttypes as defined in pt:RecognitionType. For custom defined identifier types, free text \n\t\t\t\t\t\t\tcan be used." + }, + { + "use": "optional", + "name": "IdentifierAccess", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this access point supports the AccessControl/Request/Identifier\n\t\t\t\t\t\t\tevent to request external authorization.\n\t\t\t\t\t\t\tIdentfier access requires that ExternalAuthorization is set to true.\n\t\t\t\t\t\t\tThe IdentifierAccess capability is typically enabled for devices that do not have any \n\t\t\t\t\t\t\tknowledge of credential tokens. When IdentifierAccess is set to true then the device \n\t\t\t\t\t\t\tmust support the identifier events." + }, + { + "use": "optional", + "name": "SupportedFeedbackTypes", + "type": "{http://www.onvif.org/ver10/pacs}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported feedback types. Feedback types starting with the prefix pt:\n\t\t\t\t\t\t\tare reserved to define ONVIF-specific types as defined in tac:FeedbackType.\n\t\t\t\t\t\t\tFor custom defined feedback types, free text can be used." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the AccessPoint." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "AuthenticationProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A reference to an authentication profile which defines the authentication\n\t\t\t\t\t\t\t\t\t\tbehavior of the access point." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointExtension", + "type_name": "AccessPointExtension", + "definition": { + "kind": "complexType", + "name": "AccessPointExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "AccessPoint item to modify" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}ModifyAccessPointResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}ModifyAccessPointResponse", + "schema": { + "name": "ModifyAccessPointResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "DeleteAccessPoint", + "port_type": "PACSPort", + "description": "This operation deletes the specified access point. If it is associated with one or more entities some devices may not be able to delete the access point, and consequently a ReferenceInUse fault shall be generated. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DeleteAccessPointRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DeleteAccessPoint", + "schema": { + "name": "DeleteAccessPoint", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of AccessPoint item to delete." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DeleteAccessPointResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DeleteAccessPointResponse", + "schema": { + "name": "DeleteAccessPointResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "SetAccessPointAuthenticationProfile", + "port_type": "PACSPort", + "description": "This operation defines the authentication behavior for an access point.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SetAccessPointAuthenticationProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SetAccessPointAuthenticationProfile", + "schema": { + "name": "SetAccessPointAuthenticationProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the AccessPoint." + }, + { + "name": "AuthenticationProfileToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the AuthenticationProfile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SetAccessPointAuthenticationProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SetAccessPointAuthenticationProfileResponse", + "schema": { + "name": "SetAccessPointAuthenticationProfileResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "DeleteAccessPointAuthenticationProfile", + "port_type": "PACSPort", + "description": "This operation reverts the authentication behavior for an access point to its default behavior.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DeleteAccessPointAuthenticationProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DeleteAccessPointAuthenticationProfile", + "schema": { + "name": "DeleteAccessPointAuthenticationProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the AccessPoint." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DeleteAccessPointAuthenticationProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DeleteAccessPointAuthenticationProfileResponse", + "schema": { + "name": "DeleteAccessPointAuthenticationProfileResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "GetAreaInfo", + "port_type": "PACSPort", + "description": "This operation requests a list of AreaInfo items matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreaInfoRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreaInfo", + "schema": { + "name": "GetAreaInfo", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of AreaInfo items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreaInfoResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreaInfoResponse", + "schema": { + "name": "GetAreaInfoResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AreaInfo", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfo", + "type_name": "AreaInfo", + "definition": { + "kind": "complexType", + "name": "AreaInfo", + "description": "The AreaInfo structure contains basic information about an Area.\n\t\t\t\t\t\tAn ONVIF compliant device shall provide the following fields for each Area:", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AreaInfoBase", + "description": "Basic information about an Area. Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the Area. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of AreaInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "GetAreaInfoList", + "port_type": "PACSPort", + "description": "This operation requests a list of all AreaInfo items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. The number of items returned shall not be greater than the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreaInfoListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreaInfoList", + "schema": { + "name": "GetAreaInfoList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is determined by the\n\t\t\t\t\t\t\t\t\tdevice." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreaInfoListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreaInfoListResponse", + "schema": { + "name": "GetAreaInfoListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "AreaInfo", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfo", + "type_name": "AreaInfo", + "definition": { + "kind": "complexType", + "name": "AreaInfo", + "description": "The AreaInfo structure contains basic information about an Area.\n\t\t\t\t\t\tAn ONVIF compliant device shall provide the following fields for each Area:", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AreaInfoBase", + "description": "Basic information about an Area. Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the Area. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of AreaInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "GetAreas", + "port_type": "PACSPort", + "description": "This operation requests a list of Area items matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreasRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreas", + "schema": { + "name": "GetAreas", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of Area items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreasResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreasResponse", + "schema": { + "name": "GetAreasResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Area", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}Area", + "type_name": "Area", + "definition": { + "kind": "complexType", + "name": "Area", + "description": "The Area structure shall include all properties of the AreaInfo structure and optionally\n\t\t\t\t\t\ta parent area token, an OccupancyControl structure and/or an Antipassback structure.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfo", + "base_definition": { + "kind": "complexType", + "name": "AreaInfo", + "description": "The AreaInfo structure contains basic information about an Area.\n\t\t\t\t\t\tAn ONVIF compliant device shall provide the following fields for each Area:", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AreaInfoBase", + "description": "Basic information about an Area. Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the Area. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaExtension", + "type_name": "AreaExtension", + "definition": { + "kind": "complexType", + "name": "AreaExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of Area items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "GetAreaList", + "port_type": "PACSPort", + "description": "This operation requests a list of all Area items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. The number of items returned shall not be greater than the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreaListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreaList", + "schema": { + "name": "GetAreaList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is determined by the\n\t\t\t\t\t\t\t\t\tdevice." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreaListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAreaListResponse", + "schema": { + "name": "GetAreaListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "Area", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}Area", + "type_name": "Area", + "definition": { + "kind": "complexType", + "name": "Area", + "description": "The Area structure shall include all properties of the AreaInfo structure and optionally\n\t\t\t\t\t\ta parent area token, an OccupancyControl structure and/or an Antipassback structure.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfo", + "base_definition": { + "kind": "complexType", + "name": "AreaInfo", + "description": "The AreaInfo structure contains basic information about an Area.\n\t\t\t\t\t\tAn ONVIF compliant device shall provide the following fields for each Area:", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AreaInfoBase", + "description": "Basic information about an Area. Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the Area. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaExtension", + "type_name": "AreaExtension", + "definition": { + "kind": "complexType", + "name": "AreaExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of Area items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "CreateArea", + "port_type": "PACSPort", + "description": "This operation creates the specified area in the device. The token field of the Area structure shall be empty and the device shall allocate a token for the area. The allocated token shall be returned in the response. If the client sends any value in the token field, the device shall return InvalidArgVal as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}CreateAreaRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}CreateArea", + "schema": { + "name": "CreateArea", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Area", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}Area", + "type_name": "Area", + "definition": { + "kind": "complexType", + "name": "Area", + "description": "The Area structure shall include all properties of the AreaInfo structure and optionally\n\t\t\t\t\t\ta parent area token, an OccupancyControl structure and/or an Antipassback structure.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfo", + "base_definition": { + "kind": "complexType", + "name": "AreaInfo", + "description": "The AreaInfo structure contains basic information about an Area.\n\t\t\t\t\t\tAn ONVIF compliant device shall provide the following fields for each Area:", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AreaInfoBase", + "description": "Basic information about an Area. Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the Area. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaExtension", + "type_name": "AreaExtension", + "definition": { + "kind": "complexType", + "name": "AreaExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Area item to create" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}CreateAreaResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}CreateAreaResponse", + "schema": { + "name": "CreateAreaResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of created Area item" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "SetArea", + "port_type": "PACSPort", + "description": "This method is used to synchronize an area in a client with the device. If an area with the specified token does not exist in the device, the area is created. If an area with the specified token exists, then the area is modified. A call to this method takes an Area structure as input parameter. The token field of the Area structure shall not be empty. A device that signals support for the ClientSuppliedTokenSupported capability shall implement this command. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SetAreaRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SetArea", + "schema": { + "name": "SetArea", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Area", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}Area", + "type_name": "Area", + "definition": { + "kind": "complexType", + "name": "Area", + "description": "The Area structure shall include all properties of the AreaInfo structure and optionally\n\t\t\t\t\t\ta parent area token, an OccupancyControl structure and/or an Antipassback structure.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfo", + "base_definition": { + "kind": "complexType", + "name": "AreaInfo", + "description": "The AreaInfo structure contains basic information about an Area.\n\t\t\t\t\t\tAn ONVIF compliant device shall provide the following fields for each Area:", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AreaInfoBase", + "description": "Basic information about an Area. Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the Area. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaExtension", + "type_name": "AreaExtension", + "definition": { + "kind": "complexType", + "name": "AreaExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Area item to create or modify" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SetAreaResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}SetAreaResponse", + "schema": { + "name": "SetAreaResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "ModifyArea", + "port_type": "PACSPort", + "description": "This operation modifies the specified area. The token of the area to modify is specified in the token field of the Area structure and shall not be empty. All other fields in the structure shall overwrite the fields in the specified area. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}ModifyAreaRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}ModifyArea", + "schema": { + "name": "ModifyArea", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Area", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}Area", + "type_name": "Area", + "definition": { + "kind": "complexType", + "name": "Area", + "description": "The Area structure shall include all properties of the AreaInfo structure and optionally\n\t\t\t\t\t\ta parent area token, an OccupancyControl structure and/or an Antipassback structure.", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfo", + "base_definition": { + "kind": "complexType", + "name": "AreaInfo", + "description": "The AreaInfo structure contains basic information about an Area.\n\t\t\t\t\t\tAn ONVIF compliant device shall provide the following fields for each Area:", + "base": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaInfoBase", + "base_definition": { + "kind": "complexType", + "name": "AreaInfoBase", + "description": "Basic information about an Area. Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the Area. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AreaExtension", + "type_name": "AreaExtension", + "definition": { + "kind": "complexType", + "name": "AreaExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Area item to modify" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}ModifyAreaResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}ModifyAreaResponse", + "schema": { + "name": "ModifyAreaResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "DeleteArea", + "port_type": "PACSPort", + "description": "This operation deletes the specified area. If it is associated with one or more entities some devices may not be able to delete the area, and consequently a ReferenceInUse fault shall be generated. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DeleteAreaRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DeleteArea", + "schema": { + "name": "DeleteArea", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of Area item to delete." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DeleteAreaResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DeleteAreaResponse", + "schema": { + "name": "DeleteAreaResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "GetAccessPointState", + "port_type": "PACSPort", + "description": "This operation requests the AccessPointState for the access point instance specified by the token.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointStateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointState", + "schema": { + "name": "GetAccessPointState", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of AccessPoint instance to get AccessPointState for." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointStateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}GetAccessPointStateResponse", + "schema": { + "name": "GetAccessPointStateResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AccessPointState", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}AccessPointState", + "type_name": "AccessPointState", + "definition": { + "kind": "complexType", + "name": "AccessPointState", + "description": "The AccessPointState contains state information for an AccessPoint.\n\t\t\t\t\t\tAn ONVIF compliant device shall provide the following fields for each AccessPoint instance:", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates that the AccessPoint is enabled. By default this field value\n\t\t\t\t\t\t\t\tshall be True, if the DisableAccessPoint capabilities is not supported." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "AccessPointState item." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "EnableAccessPoint", + "port_type": "PACSPort", + "description": "This operation allows enabling an access point. A device that signals support for DisableAccessPoint capability for a particular access point instance shall implement this command.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}EnableAccessPointRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}EnableAccessPoint", + "schema": { + "name": "EnableAccessPoint", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the AccessPoint instance to enable." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}EnableAccessPointResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}EnableAccessPointResponse", + "schema": { + "name": "EnableAccessPointResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "DisableAccessPoint", + "port_type": "PACSPort", + "description": "This operation allows disabling an access point. A device that signals support for the DisableAccessPoint capability for a particular access point instance shall implement this command.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DisableAccessPointRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DisableAccessPoint", + "schema": { + "name": "DisableAccessPoint", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the AccessPoint instance to disable." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DisableAccessPointResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}DisableAccessPointResponse", + "schema": { + "name": "DisableAccessPointResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "ExternalAuthorization", + "port_type": "PACSPort", + "description": "This operation allows to deny or grant decision at an access point instance. A device that signals support for ExternalAuthorization capability for a particular access point instance shall implement this method.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}ExternalAuthorizationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}ExternalAuthorization", + "schema": { + "name": "ExternalAuthorization", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AccessPointToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Access Point instance." + }, + { + "name": "CredentialToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional token of the Credential involved." + }, + { + "name": "Reason", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reason for decision." + }, + { + "name": "Decision", + "type": "{http://www.onvif.org/ver10/accesscontrol/wsdl}Decision", + "type_name": "Decision", + "definition": { + "kind": "simpleType", + "name": "Decision", + "description": "The Decision enumeration represents a choice of two available options for an access request:", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Granted", + "description": "The decision is to grant access." + }, + { + "value": "Denied", + "description": "The decision is to deny access." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Decision - Granted or Denied." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}ExternalAuthorizationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}ExternalAuthorizationResponse", + "schema": { + "name": "ExternalAuthorizationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + }, + { + "name": "Feedback", + "port_type": "PACSPort", + "description": "This operation controls how the specified access point should indicate feedback. A client can instruct the access point about the door status or that one or more identifiers are needed to grant access, etc. It is typically used in conjunction with the AccessControl/Request/Identifier event and the ExternalAuthorization operation to indicate progress and required recognition methods. The supported feedback types are indicated in the SupportedFeedbackTypes field in the access point capabilities. In cases where multiple combinations of recognition methods are possible, the RecognitionType field can contain multiple values. E.g. for the security level \"Card+PIN or Card+Fingerprint\", the feedback command for requesting the second recognition method would contain both pt:PIN and pt:Fingerprint in the RecognitionType field. If the device supports at least one feedback type the device shall implement this command.", + "input": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}FeedbackRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}Feedback", + "schema": { + "name": "Feedback", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AccessPointToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the access point to control." + }, + { + "name": "FeedbackType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The feedback type to use. Feedback types starting with the prefix pt: \n\t\t\t\t\t\t\t\t\tare reserved to define ONVIF-specific types as defined in tac:FeedbackType.\n\t\t\t\t\t\t\t\t\tFor custom defined feedback types, free text can be used.\n\t\t\t\t\t\t\t\t\tIf feedback type is set to pt:RequireIdentifier, the RecognitionType field shall provide the required type(s).\n\t\t\t\t\t\t\t\t\tIf the feedback type is not supported, it shall be ignored." + }, + { + "name": "RecognitionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional list of recognition types requested by a client to get closer to making a decision.\n\t\t\t\t\t\t\t\t\tUsed if FeedbackType is set to pt:RequireIdentifier.\n\t\t\t\t\t\t\t\t\tIf a recognition type is not supported, it shall be ignored." + }, + { + "name": "TextMessage", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional textual feedback message.\n\t\t\t\t\t\t\t\t\tIf not supported by the access point it shall be ignored." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/accesscontrol/wsdl}FeedbackResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/accesscontrol/wsdl}FeedbackResponse", + "schema": { + "name": "FeedbackResponse", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PACSBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/pacs/doorcontrol.json b/docs/generated/wsdl/ver10/pacs/doorcontrol.json new file mode 100644 index 00000000..39c84cf7 --- /dev/null +++ b/docs/generated/wsdl/ver10/pacs/doorcontrol.json @@ -0,0 +1,3653 @@ +{ + "source": "ver10/pacs/doorcontrol.wsdl", + "target_namespace": "http://www.onvif.org/ver10/doorcontrol/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "DoorControlPort", + "description": "This operation returns the capabilities of the service. An ONVIF compliant device which provides the Door Control service shall implement this method.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}ServiceCapabilities", + "type_name": "ServiceCapabilities", + "definition": { + "kind": "complexType", + "name": "ServiceCapabilities", + "description": "ServiceCapabilities structure reflects optional functionality of a service.\n\t\t\t\t\t\tThe information is static and does not change during device operation.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "MaxLimit", + "type": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "description": "The maximum number of entries returned by a single Get<Entity>List or\n\t\t\t\t\t\t\tGet<Entity> request. The device shall never return more than this number of entities\n\t\t\t\t\t\t\tin a single response." + }, + { + "use": "optional", + "name": "MaxDoors", + "type": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "default": "10", + "description": "Indicates the maximum number of doors supported by the device." + }, + { + "use": "optional", + "name": "ClientSuppliedTokenSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false", + "description": "Indicates that the client is allowed to supply the token when creating doors.\n\t\t\t\t\t\t\tTo enable the use of the command SetDoor, the value must be set to true." + }, + { + "use": "optional", + "name": "DoorManagementSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false", + "description": "Indicates that the client can perform CRUD operations (create, read, update and delete)\n\t\t\t\t\t\t\ton doors. To enable the use of the commands GetDoors, GetDoorList, CreateDoor, ModifyDoor\n\t\t\t\t\t\t\tand DeleteDoor, the value must be set to true." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capability response message contains the requested DoorControl\n\t\t\t\t\t\t\t\t\tservice capabilities using a hierarchical XML capability structure." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "GetDoorInfoList", + "port_type": "DoorControlPort", + "description": "This operation requests a list of all DoorInfo items provided by the device. An ONVIF compliant device that provides Door Control service shall implement this method. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. The number of items returned shall not be greater than Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorInfoListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorInfoList", + "schema": { + "name": "GetDoorInfoList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If Limit is omitted or if the\n\t\t\t\t\t\t\t\t\tvalue of Limit is higher than what the device supports, then the device shall\n\t\t\t\t\t\t\t\t\treturn its maximum amount of entries." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorInfoListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorInfoListResponse", + "schema": { + "name": "GetDoorInfoListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "DoorInfo", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorInfo", + "type_name": "DoorInfo", + "definition": { + "kind": "complexType", + "name": "DoorInfo", + "description": "The DoorInfo type represents the Door as a physical object.\n\t\t\t\t\t\tThe structure contains information and capabilities of a specific door instance.\n\t\t\t\t\t\tAn ONVIF compliant device shall provide the following fields for each Door instance:", + "base": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorInfoBase", + "base_definition": { + "kind": "complexType", + "name": "DoorInfoBase", + "description": "Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A user readable description. It shall be up to 1024 characters." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorCapabilities", + "type_name": "DoorCapabilities", + "definition": { + "kind": "complexType", + "name": "DoorCapabilities", + "description": "DoorCapabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent door instances may have different set of capabilities.\n\t\t\t\t\t\tThis information may change during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Access", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this Door instance supports AccessDoor command to\n\t\t\t\t\t\t\tperform momentary access." + }, + { + "use": "optional", + "name": "AccessTimingOverride", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports overriding configured timing in the\n\t\t\t\t\t\t\tAccessDoor command." + }, + { + "use": "optional", + "name": "Lock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDoor command to lock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Unlock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports UnlockDoor command to unlock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Block", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports BlockDoor command to block the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "DoubleLock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports DoubleLockDoor command to lock\n\t\t\t\t\t\t\tmultiple locks on the door." + }, + { + "use": "optional", + "name": "LockDown", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDown (and LockDownRelease)\n\t\t\t\t\t\t\tcommands to lock the door and put it in LockedDown mode." + }, + { + "use": "optional", + "name": "LockOpen", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockOpen (and LockOpenRelease)\n\t\t\t\t\t\t\tcommands to unlock the door and put it in LockedOpen mode." + }, + { + "use": "optional", + "name": "DoorMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoorMonitor and supports the\n\t\t\t\t\t\t\tDoorPhysicalState event." + }, + { + "use": "optional", + "name": "LockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a LockMonitor and supports the\n\t\t\t\t\t\t\tLockPhysicalState event." + }, + { + "use": "optional", + "name": "DoubleLockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoubleLockMonitor and supports the\n\t\t\t\t\t\t\tDoubleLockPhysicalState event." + }, + { + "use": "optional", + "name": "Alarm", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door alarm and the DoorAlarm\n\t\t\t\t\t\t\tevent." + }, + { + "use": "optional", + "name": "Tamper", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a Tamper detector and supports the\n\t\t\t\t\t\t\tDoorTamper event." + }, + { + "use": "optional", + "name": "Fault", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door fault and the DoorFault\n\t\t\t\t\t\t\tevent." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities of the Door." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of DoorInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "GetDoorInfo", + "port_type": "DoorControlPort", + "description": "This operation requests a list of DoorInfo items matching the given tokens. An ONVIF-compliant device that provides Door Control service shall implement this method. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching specified tokens. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorInfoRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorInfo", + "schema": { + "name": "GetDoorInfo", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of DoorInfo items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorInfoResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorInfoResponse", + "schema": { + "name": "GetDoorInfoResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DoorInfo", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorInfo", + "type_name": "DoorInfo", + "definition": { + "kind": "complexType", + "name": "DoorInfo", + "description": "The DoorInfo type represents the Door as a physical object.\n\t\t\t\t\t\tThe structure contains information and capabilities of a specific door instance.\n\t\t\t\t\t\tAn ONVIF compliant device shall provide the following fields for each Door instance:", + "base": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorInfoBase", + "base_definition": { + "kind": "complexType", + "name": "DoorInfoBase", + "description": "Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A user readable description. It shall be up to 1024 characters." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorCapabilities", + "type_name": "DoorCapabilities", + "definition": { + "kind": "complexType", + "name": "DoorCapabilities", + "description": "DoorCapabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent door instances may have different set of capabilities.\n\t\t\t\t\t\tThis information may change during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Access", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this Door instance supports AccessDoor command to\n\t\t\t\t\t\t\tperform momentary access." + }, + { + "use": "optional", + "name": "AccessTimingOverride", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports overriding configured timing in the\n\t\t\t\t\t\t\tAccessDoor command." + }, + { + "use": "optional", + "name": "Lock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDoor command to lock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Unlock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports UnlockDoor command to unlock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Block", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports BlockDoor command to block the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "DoubleLock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports DoubleLockDoor command to lock\n\t\t\t\t\t\t\tmultiple locks on the door." + }, + { + "use": "optional", + "name": "LockDown", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDown (and LockDownRelease)\n\t\t\t\t\t\t\tcommands to lock the door and put it in LockedDown mode." + }, + { + "use": "optional", + "name": "LockOpen", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockOpen (and LockOpenRelease)\n\t\t\t\t\t\t\tcommands to unlock the door and put it in LockedOpen mode." + }, + { + "use": "optional", + "name": "DoorMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoorMonitor and supports the\n\t\t\t\t\t\t\tDoorPhysicalState event." + }, + { + "use": "optional", + "name": "LockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a LockMonitor and supports the\n\t\t\t\t\t\t\tLockPhysicalState event." + }, + { + "use": "optional", + "name": "DoubleLockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoubleLockMonitor and supports the\n\t\t\t\t\t\t\tDoubleLockPhysicalState event." + }, + { + "use": "optional", + "name": "Alarm", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door alarm and the DoorAlarm\n\t\t\t\t\t\t\tevent." + }, + { + "use": "optional", + "name": "Tamper", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a Tamper detector and supports the\n\t\t\t\t\t\t\tDoorTamper event." + }, + { + "use": "optional", + "name": "Fault", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door fault and the DoorFault\n\t\t\t\t\t\t\tevent." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities of the Door." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of DoorInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "GetDoorList", + "port_type": "DoorControlPort", + "description": "This operation requests a list of all Door items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer to section 4.8.3 in [Access Control Service Specification] for more details. The number of items returned shall not be greater than the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorList", + "schema": { + "name": "GetDoorList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is determined by the\n\t\t\t\t\t\t\t\t\tdevice." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference. If not specified,\n\t\t\t\t\t\t\t\t\tentries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorListResponse", + "schema": { + "name": "GetDoorListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "Door", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}Door", + "type_name": "Door", + "definition": { + "kind": "complexType", + "name": "Door", + "description": "The door structure shall include all properties of the DoorInfo structure and also a timings\n\t\t\t\t\t\tstructure.", + "base": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorInfoBase", + "base_definition": { + "kind": "complexType", + "name": "DoorInfoBase", + "description": "Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A user readable description. It shall be up to 1024 characters." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorCapabilities", + "type_name": "DoorCapabilities", + "definition": { + "kind": "complexType", + "name": "DoorCapabilities", + "description": "DoorCapabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent door instances may have different set of capabilities.\n\t\t\t\t\t\tThis information may change during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Access", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this Door instance supports AccessDoor command to\n\t\t\t\t\t\t\tperform momentary access." + }, + { + "use": "optional", + "name": "AccessTimingOverride", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports overriding configured timing in the\n\t\t\t\t\t\t\tAccessDoor command." + }, + { + "use": "optional", + "name": "Lock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDoor command to lock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Unlock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports UnlockDoor command to unlock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Block", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports BlockDoor command to block the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "DoubleLock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports DoubleLockDoor command to lock\n\t\t\t\t\t\t\tmultiple locks on the door." + }, + { + "use": "optional", + "name": "LockDown", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDown (and LockDownRelease)\n\t\t\t\t\t\t\tcommands to lock the door and put it in LockedDown mode." + }, + { + "use": "optional", + "name": "LockOpen", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockOpen (and LockOpenRelease)\n\t\t\t\t\t\t\tcommands to unlock the door and put it in LockedOpen mode." + }, + { + "use": "optional", + "name": "DoorMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoorMonitor and supports the\n\t\t\t\t\t\t\tDoorPhysicalState event." + }, + { + "use": "optional", + "name": "LockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a LockMonitor and supports the\n\t\t\t\t\t\t\tLockPhysicalState event." + }, + { + "use": "optional", + "name": "DoubleLockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoubleLockMonitor and supports the\n\t\t\t\t\t\t\tDoubleLockPhysicalState event." + }, + { + "use": "optional", + "name": "Alarm", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door alarm and the DoorAlarm\n\t\t\t\t\t\t\tevent." + }, + { + "use": "optional", + "name": "Tamper", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a Tamper detector and supports the\n\t\t\t\t\t\t\tDoorTamper event." + }, + { + "use": "optional", + "name": "Fault", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door fault and the DoorFault\n\t\t\t\t\t\t\tevent." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities of the Door." + }, + { + "name": "DoorType", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The type of door. Is of type text. Can be either one of the following reserved\n\t\t\t\t\t\t\t\t\t\tONVIF types: \"pt:Door\", \"pt:ManTrap\", \"pt:Turnstile\", \"pt:RevolvingDoor\",\n\t\t\t\t\t\t\t\t\t\t\"pt:Barrier\", or a custom defined type." + }, + { + "name": "Timings", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}Timings", + "type_name": "Timings", + "definition": { + "kind": "complexType", + "name": "Timings", + "description": "A structure defining times such as how long the door is unlocked when accessed,\n\t\t\t\t\t\textended grant time, etc.", + "fields": [ + { + "name": "ReleaseTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "When access is granted (door mode becomes Accessed), the latch is unlocked.\n\t\t\t\t\t\t\t\tReleaseTime is the time from when the latch is unlocked until it is\n\t\t\t\t\t\t\t\trelocked again (unless the door is physically opened)." + }, + { + "name": "OpenTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time from when the door is physically opened until the door is set in the\n\t\t\t\t\t\t\t\tDoorOpenTooLong alarm state." + }, + { + "name": "ExtendedReleaseTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Some individuals need extra time to open the door before the latch relocks.\n\t\t\t\t\t\t\t\tIf supported, ExtendedReleaseTime shall be added to ReleaseTime if UseExtendedTime\n\t\t\t\t\t\t\t\tis set to true in the AccessDoor command." + }, + { + "name": "DelayTimeBeforeRelock", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the door is physically opened after access is granted,\n\t\t\t\t\t\t\t\tthen DelayTimeBeforeRelock is the time from when the door is physically\n\t\t\t\t\t\t\t\topened until the latch goes back to locked state." + }, + { + "name": "ExtendedOpenTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Some individuals need extra time to pass through the door. If supported,\n\t\t\t\t\t\t\t\tExtendedOpenTime shall be added to OpenTime if UseExtendedTime is set to true\n\t\t\t\t\t\t\t\tin the AccessDoor command." + }, + { + "name": "PreAlarmTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Before a DoorOpenTooLong alarm state is generated, a signal will sound to indicate\n\t\t\t\t\t\t\t\tthat the door must be closed. PreAlarmTime defines how long before DoorOpenTooLong\n\t\t\t\t\t\t\t\tthe warning signal shall sound." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}TimingsExtension", + "type_name": "TimingsExtension", + "definition": { + "kind": "complexType", + "name": "TimingsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A structure defining times such as how long the door is unlocked when\n\t\t\t\t\t\t\t\t\t\taccessed, extended grant time, etc." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorExtension", + "type_name": "DoorExtension", + "definition": { + "kind": "complexType", + "name": "DoorExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of Door items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "GetDoors", + "port_type": "DoorControlPort", + "description": "This operation requests a list of Door items matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoors", + "schema": { + "name": "GetDoors", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of Door items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorsResponse", + "schema": { + "name": "GetDoorsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Door", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}Door", + "type_name": "Door", + "definition": { + "kind": "complexType", + "name": "Door", + "description": "The door structure shall include all properties of the DoorInfo structure and also a timings\n\t\t\t\t\t\tstructure.", + "base": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorInfoBase", + "base_definition": { + "kind": "complexType", + "name": "DoorInfoBase", + "description": "Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A user readable description. It shall be up to 1024 characters." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorCapabilities", + "type_name": "DoorCapabilities", + "definition": { + "kind": "complexType", + "name": "DoorCapabilities", + "description": "DoorCapabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent door instances may have different set of capabilities.\n\t\t\t\t\t\tThis information may change during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Access", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this Door instance supports AccessDoor command to\n\t\t\t\t\t\t\tperform momentary access." + }, + { + "use": "optional", + "name": "AccessTimingOverride", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports overriding configured timing in the\n\t\t\t\t\t\t\tAccessDoor command." + }, + { + "use": "optional", + "name": "Lock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDoor command to lock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Unlock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports UnlockDoor command to unlock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Block", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports BlockDoor command to block the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "DoubleLock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports DoubleLockDoor command to lock\n\t\t\t\t\t\t\tmultiple locks on the door." + }, + { + "use": "optional", + "name": "LockDown", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDown (and LockDownRelease)\n\t\t\t\t\t\t\tcommands to lock the door and put it in LockedDown mode." + }, + { + "use": "optional", + "name": "LockOpen", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockOpen (and LockOpenRelease)\n\t\t\t\t\t\t\tcommands to unlock the door and put it in LockedOpen mode." + }, + { + "use": "optional", + "name": "DoorMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoorMonitor and supports the\n\t\t\t\t\t\t\tDoorPhysicalState event." + }, + { + "use": "optional", + "name": "LockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a LockMonitor and supports the\n\t\t\t\t\t\t\tLockPhysicalState event." + }, + { + "use": "optional", + "name": "DoubleLockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoubleLockMonitor and supports the\n\t\t\t\t\t\t\tDoubleLockPhysicalState event." + }, + { + "use": "optional", + "name": "Alarm", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door alarm and the DoorAlarm\n\t\t\t\t\t\t\tevent." + }, + { + "use": "optional", + "name": "Tamper", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a Tamper detector and supports the\n\t\t\t\t\t\t\tDoorTamper event." + }, + { + "use": "optional", + "name": "Fault", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door fault and the DoorFault\n\t\t\t\t\t\t\tevent." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities of the Door." + }, + { + "name": "DoorType", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The type of door. Is of type text. Can be either one of the following reserved\n\t\t\t\t\t\t\t\t\t\tONVIF types: \"pt:Door\", \"pt:ManTrap\", \"pt:Turnstile\", \"pt:RevolvingDoor\",\n\t\t\t\t\t\t\t\t\t\t\"pt:Barrier\", or a custom defined type." + }, + { + "name": "Timings", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}Timings", + "type_name": "Timings", + "definition": { + "kind": "complexType", + "name": "Timings", + "description": "A structure defining times such as how long the door is unlocked when accessed,\n\t\t\t\t\t\textended grant time, etc.", + "fields": [ + { + "name": "ReleaseTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "When access is granted (door mode becomes Accessed), the latch is unlocked.\n\t\t\t\t\t\t\t\tReleaseTime is the time from when the latch is unlocked until it is\n\t\t\t\t\t\t\t\trelocked again (unless the door is physically opened)." + }, + { + "name": "OpenTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time from when the door is physically opened until the door is set in the\n\t\t\t\t\t\t\t\tDoorOpenTooLong alarm state." + }, + { + "name": "ExtendedReleaseTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Some individuals need extra time to open the door before the latch relocks.\n\t\t\t\t\t\t\t\tIf supported, ExtendedReleaseTime shall be added to ReleaseTime if UseExtendedTime\n\t\t\t\t\t\t\t\tis set to true in the AccessDoor command." + }, + { + "name": "DelayTimeBeforeRelock", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the door is physically opened after access is granted,\n\t\t\t\t\t\t\t\tthen DelayTimeBeforeRelock is the time from when the door is physically\n\t\t\t\t\t\t\t\topened until the latch goes back to locked state." + }, + { + "name": "ExtendedOpenTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Some individuals need extra time to pass through the door. If supported,\n\t\t\t\t\t\t\t\tExtendedOpenTime shall be added to OpenTime if UseExtendedTime is set to true\n\t\t\t\t\t\t\t\tin the AccessDoor command." + }, + { + "name": "PreAlarmTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Before a DoorOpenTooLong alarm state is generated, a signal will sound to indicate\n\t\t\t\t\t\t\t\tthat the door must be closed. PreAlarmTime defines how long before DoorOpenTooLong\n\t\t\t\t\t\t\t\tthe warning signal shall sound." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}TimingsExtension", + "type_name": "TimingsExtension", + "definition": { + "kind": "complexType", + "name": "TimingsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A structure defining times such as how long the door is unlocked when\n\t\t\t\t\t\t\t\t\t\taccessed, extended grant time, etc." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorExtension", + "type_name": "DoorExtension", + "definition": { + "kind": "complexType", + "name": "DoorExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of Door items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "CreateDoor", + "port_type": "DoorControlPort", + "description": "This operation creates the specified door in the device. The token field of the Door structure shall be empty and the device shall allocate a token for the door. The allocated token shall be returned in the response. If the client sends any value in the token field, the device shall return InvalidArgVal as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}CreateDoorRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}CreateDoor", + "schema": { + "name": "CreateDoor", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Door", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}Door", + "type_name": "Door", + "definition": { + "kind": "complexType", + "name": "Door", + "description": "The door structure shall include all properties of the DoorInfo structure and also a timings\n\t\t\t\t\t\tstructure.", + "base": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorInfoBase", + "base_definition": { + "kind": "complexType", + "name": "DoorInfoBase", + "description": "Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A user readable description. It shall be up to 1024 characters." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorCapabilities", + "type_name": "DoorCapabilities", + "definition": { + "kind": "complexType", + "name": "DoorCapabilities", + "description": "DoorCapabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent door instances may have different set of capabilities.\n\t\t\t\t\t\tThis information may change during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Access", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this Door instance supports AccessDoor command to\n\t\t\t\t\t\t\tperform momentary access." + }, + { + "use": "optional", + "name": "AccessTimingOverride", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports overriding configured timing in the\n\t\t\t\t\t\t\tAccessDoor command." + }, + { + "use": "optional", + "name": "Lock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDoor command to lock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Unlock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports UnlockDoor command to unlock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Block", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports BlockDoor command to block the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "DoubleLock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports DoubleLockDoor command to lock\n\t\t\t\t\t\t\tmultiple locks on the door." + }, + { + "use": "optional", + "name": "LockDown", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDown (and LockDownRelease)\n\t\t\t\t\t\t\tcommands to lock the door and put it in LockedDown mode." + }, + { + "use": "optional", + "name": "LockOpen", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockOpen (and LockOpenRelease)\n\t\t\t\t\t\t\tcommands to unlock the door and put it in LockedOpen mode." + }, + { + "use": "optional", + "name": "DoorMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoorMonitor and supports the\n\t\t\t\t\t\t\tDoorPhysicalState event." + }, + { + "use": "optional", + "name": "LockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a LockMonitor and supports the\n\t\t\t\t\t\t\tLockPhysicalState event." + }, + { + "use": "optional", + "name": "DoubleLockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoubleLockMonitor and supports the\n\t\t\t\t\t\t\tDoubleLockPhysicalState event." + }, + { + "use": "optional", + "name": "Alarm", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door alarm and the DoorAlarm\n\t\t\t\t\t\t\tevent." + }, + { + "use": "optional", + "name": "Tamper", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a Tamper detector and supports the\n\t\t\t\t\t\t\tDoorTamper event." + }, + { + "use": "optional", + "name": "Fault", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door fault and the DoorFault\n\t\t\t\t\t\t\tevent." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities of the Door." + }, + { + "name": "DoorType", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The type of door. Is of type text. Can be either one of the following reserved\n\t\t\t\t\t\t\t\t\t\tONVIF types: \"pt:Door\", \"pt:ManTrap\", \"pt:Turnstile\", \"pt:RevolvingDoor\",\n\t\t\t\t\t\t\t\t\t\t\"pt:Barrier\", or a custom defined type." + }, + { + "name": "Timings", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}Timings", + "type_name": "Timings", + "definition": { + "kind": "complexType", + "name": "Timings", + "description": "A structure defining times such as how long the door is unlocked when accessed,\n\t\t\t\t\t\textended grant time, etc.", + "fields": [ + { + "name": "ReleaseTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "When access is granted (door mode becomes Accessed), the latch is unlocked.\n\t\t\t\t\t\t\t\tReleaseTime is the time from when the latch is unlocked until it is\n\t\t\t\t\t\t\t\trelocked again (unless the door is physically opened)." + }, + { + "name": "OpenTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time from when the door is physically opened until the door is set in the\n\t\t\t\t\t\t\t\tDoorOpenTooLong alarm state." + }, + { + "name": "ExtendedReleaseTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Some individuals need extra time to open the door before the latch relocks.\n\t\t\t\t\t\t\t\tIf supported, ExtendedReleaseTime shall be added to ReleaseTime if UseExtendedTime\n\t\t\t\t\t\t\t\tis set to true in the AccessDoor command." + }, + { + "name": "DelayTimeBeforeRelock", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the door is physically opened after access is granted,\n\t\t\t\t\t\t\t\tthen DelayTimeBeforeRelock is the time from when the door is physically\n\t\t\t\t\t\t\t\topened until the latch goes back to locked state." + }, + { + "name": "ExtendedOpenTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Some individuals need extra time to pass through the door. If supported,\n\t\t\t\t\t\t\t\tExtendedOpenTime shall be added to OpenTime if UseExtendedTime is set to true\n\t\t\t\t\t\t\t\tin the AccessDoor command." + }, + { + "name": "PreAlarmTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Before a DoorOpenTooLong alarm state is generated, a signal will sound to indicate\n\t\t\t\t\t\t\t\tthat the door must be closed. PreAlarmTime defines how long before DoorOpenTooLong\n\t\t\t\t\t\t\t\tthe warning signal shall sound." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}TimingsExtension", + "type_name": "TimingsExtension", + "definition": { + "kind": "complexType", + "name": "TimingsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A structure defining times such as how long the door is unlocked when\n\t\t\t\t\t\t\t\t\t\taccessed, extended grant time, etc." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorExtension", + "type_name": "DoorExtension", + "definition": { + "kind": "complexType", + "name": "DoorExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Door item to create" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}CreateDoorResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}CreateDoorResponse", + "schema": { + "name": "CreateDoorResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of created Door item" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "SetDoor", + "port_type": "DoorControlPort", + "description": "This method is used to synchronize a door in a client with the device. If a door with the specified token does not exist in the device, the door is created. If a door with the specified token exists, then the door is modified. A call to this method takes a door structure as input parameter. The token field of the Door structure shall not be empty. A device that signals support for the ClientSuppliedTokenSupported capability shall implement this command. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}SetDoorRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}SetDoor", + "schema": { + "name": "SetDoor", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Door", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}Door", + "type_name": "Door", + "definition": { + "kind": "complexType", + "name": "Door", + "description": "The door structure shall include all properties of the DoorInfo structure and also a timings\n\t\t\t\t\t\tstructure.", + "base": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorInfoBase", + "base_definition": { + "kind": "complexType", + "name": "DoorInfoBase", + "description": "Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A user readable description. It shall be up to 1024 characters." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorCapabilities", + "type_name": "DoorCapabilities", + "definition": { + "kind": "complexType", + "name": "DoorCapabilities", + "description": "DoorCapabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent door instances may have different set of capabilities.\n\t\t\t\t\t\tThis information may change during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Access", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this Door instance supports AccessDoor command to\n\t\t\t\t\t\t\tperform momentary access." + }, + { + "use": "optional", + "name": "AccessTimingOverride", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports overriding configured timing in the\n\t\t\t\t\t\t\tAccessDoor command." + }, + { + "use": "optional", + "name": "Lock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDoor command to lock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Unlock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports UnlockDoor command to unlock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Block", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports BlockDoor command to block the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "DoubleLock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports DoubleLockDoor command to lock\n\t\t\t\t\t\t\tmultiple locks on the door." + }, + { + "use": "optional", + "name": "LockDown", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDown (and LockDownRelease)\n\t\t\t\t\t\t\tcommands to lock the door and put it in LockedDown mode." + }, + { + "use": "optional", + "name": "LockOpen", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockOpen (and LockOpenRelease)\n\t\t\t\t\t\t\tcommands to unlock the door and put it in LockedOpen mode." + }, + { + "use": "optional", + "name": "DoorMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoorMonitor and supports the\n\t\t\t\t\t\t\tDoorPhysicalState event." + }, + { + "use": "optional", + "name": "LockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a LockMonitor and supports the\n\t\t\t\t\t\t\tLockPhysicalState event." + }, + { + "use": "optional", + "name": "DoubleLockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoubleLockMonitor and supports the\n\t\t\t\t\t\t\tDoubleLockPhysicalState event." + }, + { + "use": "optional", + "name": "Alarm", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door alarm and the DoorAlarm\n\t\t\t\t\t\t\tevent." + }, + { + "use": "optional", + "name": "Tamper", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a Tamper detector and supports the\n\t\t\t\t\t\t\tDoorTamper event." + }, + { + "use": "optional", + "name": "Fault", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door fault and the DoorFault\n\t\t\t\t\t\t\tevent." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities of the Door." + }, + { + "name": "DoorType", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The type of door. Is of type text. Can be either one of the following reserved\n\t\t\t\t\t\t\t\t\t\tONVIF types: \"pt:Door\", \"pt:ManTrap\", \"pt:Turnstile\", \"pt:RevolvingDoor\",\n\t\t\t\t\t\t\t\t\t\t\"pt:Barrier\", or a custom defined type." + }, + { + "name": "Timings", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}Timings", + "type_name": "Timings", + "definition": { + "kind": "complexType", + "name": "Timings", + "description": "A structure defining times such as how long the door is unlocked when accessed,\n\t\t\t\t\t\textended grant time, etc.", + "fields": [ + { + "name": "ReleaseTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "When access is granted (door mode becomes Accessed), the latch is unlocked.\n\t\t\t\t\t\t\t\tReleaseTime is the time from when the latch is unlocked until it is\n\t\t\t\t\t\t\t\trelocked again (unless the door is physically opened)." + }, + { + "name": "OpenTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time from when the door is physically opened until the door is set in the\n\t\t\t\t\t\t\t\tDoorOpenTooLong alarm state." + }, + { + "name": "ExtendedReleaseTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Some individuals need extra time to open the door before the latch relocks.\n\t\t\t\t\t\t\t\tIf supported, ExtendedReleaseTime shall be added to ReleaseTime if UseExtendedTime\n\t\t\t\t\t\t\t\tis set to true in the AccessDoor command." + }, + { + "name": "DelayTimeBeforeRelock", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the door is physically opened after access is granted,\n\t\t\t\t\t\t\t\tthen DelayTimeBeforeRelock is the time from when the door is physically\n\t\t\t\t\t\t\t\topened until the latch goes back to locked state." + }, + { + "name": "ExtendedOpenTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Some individuals need extra time to pass through the door. If supported,\n\t\t\t\t\t\t\t\tExtendedOpenTime shall be added to OpenTime if UseExtendedTime is set to true\n\t\t\t\t\t\t\t\tin the AccessDoor command." + }, + { + "name": "PreAlarmTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Before a DoorOpenTooLong alarm state is generated, a signal will sound to indicate\n\t\t\t\t\t\t\t\tthat the door must be closed. PreAlarmTime defines how long before DoorOpenTooLong\n\t\t\t\t\t\t\t\tthe warning signal shall sound." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}TimingsExtension", + "type_name": "TimingsExtension", + "definition": { + "kind": "complexType", + "name": "TimingsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A structure defining times such as how long the door is unlocked when\n\t\t\t\t\t\t\t\t\t\taccessed, extended grant time, etc." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorExtension", + "type_name": "DoorExtension", + "definition": { + "kind": "complexType", + "name": "DoorExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The Door item to create or modify" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}SetDoorResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}SetDoorResponse", + "schema": { + "name": "SetDoorResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "ModifyDoor", + "port_type": "DoorControlPort", + "description": "This operation modifies the specified door. The token of the door to modify is specified in the token field of the Door structure and shall not be empty. All other fields in the structure shall overwrite the fields in the specified door. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}ModifyDoorRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}ModifyDoor", + "schema": { + "name": "ModifyDoor", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Door", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}Door", + "type_name": "Door", + "definition": { + "kind": "complexType", + "name": "Door", + "description": "The door structure shall include all properties of the DoorInfo structure and also a timings\n\t\t\t\t\t\tstructure.", + "base": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorInfoBase", + "base_definition": { + "kind": "complexType", + "name": "DoorInfoBase", + "description": "Used as extension base.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A user readable description. It shall be up to 1024 characters." + } + ] + }, + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorCapabilities", + "type_name": "DoorCapabilities", + "definition": { + "kind": "complexType", + "name": "DoorCapabilities", + "description": "DoorCapabilities reflect optional functionality of a particular physical entity.\n\t\t\t\t\t\tDifferent door instances may have different set of capabilities.\n\t\t\t\t\t\tThis information may change during device operation, e.g. if hardware settings are changed.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Access", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not this Door instance supports AccessDoor command to\n\t\t\t\t\t\t\tperform momentary access." + }, + { + "use": "optional", + "name": "AccessTimingOverride", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports overriding configured timing in the\n\t\t\t\t\t\t\tAccessDoor command." + }, + { + "use": "optional", + "name": "Lock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDoor command to lock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Unlock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports UnlockDoor command to unlock the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "Block", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports BlockDoor command to block the\n\t\t\t\t\t\t\tdoor." + }, + { + "use": "optional", + "name": "DoubleLock", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports DoubleLockDoor command to lock\n\t\t\t\t\t\t\tmultiple locks on the door." + }, + { + "use": "optional", + "name": "LockDown", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockDown (and LockDownRelease)\n\t\t\t\t\t\t\tcommands to lock the door and put it in LockedDown mode." + }, + { + "use": "optional", + "name": "LockOpen", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports LockOpen (and LockOpenRelease)\n\t\t\t\t\t\t\tcommands to unlock the door and put it in LockedOpen mode." + }, + { + "use": "optional", + "name": "DoorMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoorMonitor and supports the\n\t\t\t\t\t\t\tDoorPhysicalState event." + }, + { + "use": "optional", + "name": "LockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a LockMonitor and supports the\n\t\t\t\t\t\t\tLockPhysicalState event." + }, + { + "use": "optional", + "name": "DoubleLockMonitor", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a DoubleLockMonitor and supports the\n\t\t\t\t\t\t\tDoubleLockPhysicalState event." + }, + { + "use": "optional", + "name": "Alarm", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door alarm and the DoorAlarm\n\t\t\t\t\t\t\tevent." + }, + { + "use": "optional", + "name": "Tamper", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance has a Tamper detector and supports the\n\t\t\t\t\t\t\tDoorTamper event." + }, + { + "use": "optional", + "name": "Fault", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that this Door instance supports door fault and the DoorFault\n\t\t\t\t\t\t\tevent." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities of the Door." + }, + { + "name": "DoorType", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The type of door. Is of type text. Can be either one of the following reserved\n\t\t\t\t\t\t\t\t\t\tONVIF types: \"pt:Door\", \"pt:ManTrap\", \"pt:Turnstile\", \"pt:RevolvingDoor\",\n\t\t\t\t\t\t\t\t\t\t\"pt:Barrier\", or a custom defined type." + }, + { + "name": "Timings", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}Timings", + "type_name": "Timings", + "definition": { + "kind": "complexType", + "name": "Timings", + "description": "A structure defining times such as how long the door is unlocked when accessed,\n\t\t\t\t\t\textended grant time, etc.", + "fields": [ + { + "name": "ReleaseTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "When access is granted (door mode becomes Accessed), the latch is unlocked.\n\t\t\t\t\t\t\t\tReleaseTime is the time from when the latch is unlocked until it is\n\t\t\t\t\t\t\t\trelocked again (unless the door is physically opened)." + }, + { + "name": "OpenTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time from when the door is physically opened until the door is set in the\n\t\t\t\t\t\t\t\tDoorOpenTooLong alarm state." + }, + { + "name": "ExtendedReleaseTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Some individuals need extra time to open the door before the latch relocks.\n\t\t\t\t\t\t\t\tIf supported, ExtendedReleaseTime shall be added to ReleaseTime if UseExtendedTime\n\t\t\t\t\t\t\t\tis set to true in the AccessDoor command." + }, + { + "name": "DelayTimeBeforeRelock", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the door is physically opened after access is granted,\n\t\t\t\t\t\t\t\tthen DelayTimeBeforeRelock is the time from when the door is physically\n\t\t\t\t\t\t\t\topened until the latch goes back to locked state." + }, + { + "name": "ExtendedOpenTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Some individuals need extra time to pass through the door. If supported,\n\t\t\t\t\t\t\t\tExtendedOpenTime shall be added to OpenTime if UseExtendedTime is set to true\n\t\t\t\t\t\t\t\tin the AccessDoor command." + }, + { + "name": "PreAlarmTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Before a DoorOpenTooLong alarm state is generated, a signal will sound to indicate\n\t\t\t\t\t\t\t\tthat the door must be closed. PreAlarmTime defines how long before DoorOpenTooLong\n\t\t\t\t\t\t\t\tthe warning signal shall sound." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}TimingsExtension", + "type_name": "TimingsExtension", + "definition": { + "kind": "complexType", + "name": "TimingsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A structure defining times such as how long the door is unlocked when\n\t\t\t\t\t\t\t\t\t\taccessed, extended grant time, etc." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorExtension", + "type_name": "DoorExtension", + "definition": { + "kind": "complexType", + "name": "DoorExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The details of the door" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}ModifyDoorResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}ModifyDoorResponse", + "schema": { + "name": "ModifyDoorResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "DeleteDoor", + "port_type": "DoorControlPort", + "description": "This operation deletes the specified door. If it is associated with one or more entities some devices may not be able to delete the door, and consequently a ReferenceInUse fault shall be generated. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DeleteDoorRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DeleteDoor", + "schema": { + "name": "DeleteDoor", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The Token of the door to delete." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DeleteDoorResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DeleteDoorResponse", + "schema": { + "name": "DeleteDoorResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "GetDoorState", + "port_type": "DoorControlPort", + "description": "This operation requests the state of a Door specified by the Token. A device implementing the Door Control service shall be capable of reporting the status of a door using a DoorState structure available from the GetDoorState command.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorStateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorState", + "schema": { + "name": "GetDoorState", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Door instance to get the state for." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorStateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}GetDoorStateResponse", + "schema": { + "name": "GetDoorStateResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "DoorState", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorState", + "type_name": "DoorState", + "definition": { + "kind": "complexType", + "name": "DoorState", + "description": "The DoorState structure contains current aggregate runtime status of Door.", + "fields": [ + { + "name": "DoorPhysicalState", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorPhysicalState", + "type_name": "DoorPhysicalState", + "definition": { + "kind": "simpleType", + "name": "DoorPhysicalState", + "description": "The physical state of a Door.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Unknown", + "description": "Value is currently unknown (possibly due to initialization or monitors not\n\t\t\t\t\t\t\t\tgiving a conclusive result)." + }, + { + "value": "Open", + "description": "Door is open." + }, + { + "value": "Closed", + "description": "Door is closed." + }, + { + "value": "Fault", + "description": "Door monitor fault is detected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Physical state of the Door; it is of type DoorPhysicalState. A device that\n\t\t\t\t\t\t\t\tsignals support for DoorMonitor capability for a particular door instance shall provide\n\t\t\t\t\t\t\t\tthis field." + }, + { + "name": "LockPhysicalState", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockPhysicalState", + "type_name": "LockPhysicalState", + "definition": { + "kind": "simpleType", + "name": "LockPhysicalState", + "description": "The physical state of a Lock (including Double Lock).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Unknown", + "description": "Value is currently not known." + }, + { + "value": "Locked", + "description": "Lock is activated." + }, + { + "value": "Unlocked", + "description": "Lock is not activated." + }, + { + "value": "Fault", + "description": "Lock fault is detected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Physical state of the Lock; it is of type LockPhysicalState. A device that\n\t\t\t\t\t\t\t\tsignals support for LockMonitor capability for a particular door instance shall provide\n\t\t\t\t\t\t\t\tthis field." + }, + { + "name": "DoubleLockPhysicalState", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockPhysicalState", + "type_name": "LockPhysicalState", + "definition": { + "kind": "simpleType", + "name": "LockPhysicalState", + "description": "The physical state of a Lock (including Double Lock).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Unknown", + "description": "Value is currently not known." + }, + { + "value": "Locked", + "description": "Lock is activated." + }, + { + "value": "Unlocked", + "description": "Lock is not activated." + }, + { + "value": "Fault", + "description": "Lock fault is detected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Physical state of the DoubleLock; it is of type LockPhysicalState. A\n\t\t\t\t\t\t\t\tdevice that signals support for DoubleLockMonitor capability for a particular door\n\t\t\t\t\t\t\t\tinstance shall provide this field." + }, + { + "name": "Alarm", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorAlarmState", + "type_name": "DoorAlarmState", + "definition": { + "kind": "simpleType", + "name": "DoorAlarmState", + "description": "Describes the state of a Door with regard to alarms.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Normal", + "description": "No alarm." + }, + { + "value": "DoorForcedOpen", + "description": "Door is forced open." + }, + { + "value": "DoorOpenTooLong", + "description": "Door is held open too long." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Alarm state of the door; it is of type DoorAlarmState. A device that\n\t\t\t\t\t\t\t\tsignals support for Alarm capability for a particular door instance shall provide this\n\t\t\t\t\t\t\t\tfield." + }, + { + "name": "Tamper", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorTamper", + "type_name": "DoorTamper", + "definition": { + "kind": "complexType", + "name": "DoorTamper", + "description": "Tampering information for a Door.", + "fields": [ + { + "name": "Reason", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional field; Details describing tampering state change (e.g., reason,\n\t\t\t\t\t\t\t\tplace and time).\n\t\t\t\t\t\t\t\tNOTE: All fields (including this one) which are designed to give\n\t\t\t\t\t\t\t\tend-user prompts can be localized to the customer's native language." + }, + { + "name": "State", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorTamperState", + "type_name": "DoorTamperState", + "definition": { + "kind": "simpleType", + "name": "DoorTamperState", + "description": "Describes the state of a Tamper detector.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Unknown", + "description": "Value is currently not known." + }, + { + "value": "NotInTamper", + "description": "No tampering is detected." + }, + { + "value": "TamperDetected", + "description": "Tampering is detected." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "State of the tamper detector; it is of type DoorTamperState." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Tampering state of the door; it is of type DoorTamper. A device that\n\t\t\t\t\t\t\t\tsignals support for Tamper capability for a particular door instance shall provide this\n\t\t\t\t\t\t\t\tfield." + }, + { + "name": "Fault", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorFault", + "type_name": "DoorFault", + "definition": { + "kind": "complexType", + "name": "DoorFault", + "description": "Fault information for a Door.\n\t\t\t\t\t\tThis can be extended with optional attributes in the future.", + "fields": [ + { + "name": "Reason", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reason for fault." + }, + { + "name": "State", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorFaultState", + "type_name": "DoorFaultState", + "definition": { + "kind": "simpleType", + "name": "DoorFaultState", + "description": "Describes the state of a Door fault.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Unknown", + "description": "Fault state is unknown." + }, + { + "value": "NotInFault", + "description": "No fault is detected." + }, + { + "value": "FaultDetected", + "description": "Fault is detected." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Overall fault state for the door; it is of type DoorFaultState. If there\n\t\t\t\t\t\t\t\tare any faults, the value shall be: FaultDetected. Details of the detected fault shall\n\t\t\t\t\t\t\t\tbe found in the Reason field, and/or the various DoorState fields and/or in extensions\n\t\t\t\t\t\t\t\tto this structure." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Fault information for door; it is of type DoorFault. A device that signals\n\t\t\t\t\t\t\t\tsupport for Fault capability for a particular door instance shall provide this field." + }, + { + "name": "DoorMode", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoorMode", + "type_name": "DoorMode", + "definition": { + "kind": "simpleType", + "name": "DoorMode", + "description": "The DoorMode describe the mode of operation from a logical perspective. \n\t\t\t\t\t\tSetting a door mode reflects the intent to set a door in a physical state.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Unknown", + "description": "The mode of operation is unknown." + }, + { + "value": "Locked", + "description": "The intention is to set the door to a physical locked state. \n\t\t\t\t\t\t\t\tIn this mode the device shall provide momentary access using the AccessDoor \n\t\t\t\t\t\t\t\tmethod if supported by the door instance." + }, + { + "value": "Unlocked", + "description": "The intention is to set the door to a physical unlocked state. \n\t\t\t\t\t\t\t\tAlarms related to door timing operations such as open too long \n\t\t\t\t\t\t\t\tor forced open are masked in this mode." + }, + { + "value": "Accessed", + "description": "The intention is to momentary set the door to a physical unlocked state. \n\t\t\t\t\t\t\t\tAfter a predefined time the device shall revert the door to its previous mode. \n\t\t\t\t\t\t\t\tAlarms related to timing operations such as door forced open are masked in this mode." + }, + { + "value": "Blocked", + "description": "The intention is to set the door to a physical locked state and the \n\t\t\t\t\t\t\t\tdevice shall not allow AccessDoor requests, i.e. it is not possible \n\t\t\t\t\t\t\t\tfor the door to go to the accessed mode. \n\t\t\t\t\t\t\t\tAll other requests to change the door mode are allowed." + }, + { + "value": "LockedDown", + "description": "The intention is to set the door to a physical locked state and the device \n\t\t\t\t\t\t\t\tshall only allow the LockDownReleaseDoor request. \n\t\t\t\t\t\t\t\tAll other requests to change the door mode are not allowed." + }, + { + "value": "LockedOpen", + "description": "The intention is to set the door to a physical unlocked state and the \n\t\t\t\t\t\t\t\tdevice shall only allow the LockOpenReleaseDoor request. \n\t\t\t\t\t\t\t\tAll other requests to change the door mode are not allowed." + }, + { + "value": "DoubleLocked", + "description": "The intention is to set the door with multiple locks to a physical double locked state. \n\t\t\t\t\t\t\t\tIf the door does not support double locking the devices shall \n\t\t\t\t\t\t\t\ttreat this as a normal locked mode. \n\t\t\t\t\t\t\t\tWhen changing to an unlocked mode from the double locked mode, the physical state \n\t\t\t\t\t\t\t\tof the door may first go to locked state before unlocking." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The logical operating mode of the door; it is of type DoorMode. An ONVIF\n\t\t\t\t\t\t\t\tcompatible device shall report current operating mode in this field." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The state of the door." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "AccessDoor", + "port_type": "DoorControlPort", + "description": "This operation allows momentarily accessing a Door. It invokes the functionality typically used when a card holder presents a card to a card reader at the door and is granted access. The DoorMode shall change to Accessed state. Please refer to Accessed mode in section [DoorMode] for more details. The Door shall remain accessible for the defined time. When the time span elapses, the DoorMode shall change back to its previous state. If the request cannot be fulfilled, a Failure fault shall be returned. Please refer to section [DoorMode] for details about Door Modes restrictions. A device that signals support for Access capability for a particular Door instance shall implement this method. A device that signals support for AccessTimingOverride capability for a particular Door instance shall also provide optional timing parameters (AccessTime, OpenTooLongTime and PreAlarmTime) when performing AccessDoor command. The device shall take the best effort approach for parameters not supported, it must fallback to preconfigured time or limit the time to the closest supported time if the specified time is out of range.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}AccessDoorRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}AccessDoor", + "schema": { + "name": "AccessDoor", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Door instance to control." + }, + { + "name": "UseExtendedTime", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional - Indicates that the configured extended time should be\n\t\t\t\t\t\t\t\t\tused." + }, + { + "name": "AccessTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional - overrides ReleaseTime if specified." + }, + { + "name": "OpenTooLongTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional - overrides OpenTime if specified." + }, + { + "name": "PreAlarmTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional - overrides PreAlarmTime if specified." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/doorcontrol/wsdl}AccessDoorExtension", + "type_name": "AccessDoorExtension", + "definition": { + "kind": "complexType", + "name": "AccessDoorExtension", + "description": "Extension for the AccessDoor command.", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Future extension." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}AccessDoorResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}AccessDoorResponse", + "schema": { + "name": "AccessDoorResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "LockDoor", + "port_type": "DoorControlPort", + "description": "This operation allows locking a Door. The DoorMode shall change to Locked state. Please refer to Locked mode in section [DoorMode] for more details. A device that signals support for Lock capability for a particular Door instance shall implement this method. If the request cannot be fulfilled, a Failure fault shall be returned. Please refer to section [DoorMode] for more details about Door Modes restrictions.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockDoorRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockDoor", + "schema": { + "name": "LockDoor", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Door instance to control." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockDoorResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockDoorResponse", + "schema": { + "name": "LockDoorResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "UnlockDoor", + "port_type": "DoorControlPort", + "description": "This operation allows unlocking a Door. The DoorMode shall change to Unlocked state. Please refer to Unlocked mode in section [DoorMode] for more details. A device that signals support for Unlock capability for a particular Door instance shall implement this method. If the request cannot be fulfilled, a Failure fault shall be returned. Please refer to section [DoorMode] for more details about Door Modes restrictions.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}UnlockDoorRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}UnlockDoor", + "schema": { + "name": "UnlockDoor", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Door instance to control." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}UnlockDoorResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}UnlockDoorResponse", + "schema": { + "name": "UnlockDoorResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "BlockDoor", + "port_type": "DoorControlPort", + "description": "This operation allows blocking a Door and preventing momentary access (AccessDoor command). The DoorMode shall change to Blocked state. Please refer to Blocked mode in section [DoorMode] for more details. A device that signals support for Block capability for a particular Door instance shall implement this method. If the request cannot be fulfilled, a Failure fault shall be returned. Please refer to section [DoorMode] for more details about Door Modes restrictions.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}BlockDoorRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}BlockDoor", + "schema": { + "name": "BlockDoor", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Door instance to control." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}BlockDoorResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}BlockDoorResponse", + "schema": { + "name": "BlockDoorResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "LockDownDoor", + "port_type": "DoorControlPort", + "description": "This operation allows locking and preventing other actions until a LockDownRelease command is invoked. The DoorMode shall change to LockedDown state. Please refer to LockedDown mode in section [DoorMode] for more details. The device shall ignore other door control commands until a LockDownRelease command is performed. A device that signals support for LockDown capability for a particular Door instance shall implement this method. If a device supports DoubleLock capability for a particular Door instance, that operation may be engaged as well. If the request cannot be fulfilled, a Failure fault shall be returned. Please refer to section [DoorMode] for more details about Door Modes restrictions.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockDownDoorRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockDownDoor", + "schema": { + "name": "LockDownDoor", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Door instance to control." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockDownDoorResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockDownDoorResponse", + "schema": { + "name": "LockDownDoorResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "LockDownReleaseDoor", + "port_type": "DoorControlPort", + "description": "This operation allows releasing the LockedDown state of a Door. The DoorMode shall change back to its previous/next state. It is not defined what the previous/next state shall be, but typically - Locked. This method shall only succeed if the current DoorMode is LockedDown.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockDownReleaseDoorRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockDownReleaseDoor", + "schema": { + "name": "LockDownReleaseDoor", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Door instance to control." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockDownReleaseDoorResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockDownReleaseDoorResponse", + "schema": { + "name": "LockDownReleaseDoorResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "LockOpenDoor", + "port_type": "DoorControlPort", + "description": "This operation allows unlocking a Door and preventing other actions until LockOpenRelease method is invoked. The DoorMode shall change to LockedOpen state. Please refer to LockedOpen mode in section [DoorMode] for more details. The device shall ignore other door control commands until a LockOpenRelease command is performed. A device that signals support for LockOpen capability for a particular Door instance shall implement this method. If the request cannot be fulfilled, a Failure fault shall be returned. Please refer to section [DoorMode] for more details about Door Modes restrictions.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockOpenDoorRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockOpenDoor", + "schema": { + "name": "LockOpenDoor", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Door instance to control." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockOpenDoorResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockOpenDoorResponse", + "schema": { + "name": "LockOpenDoorResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "LockOpenReleaseDoor", + "port_type": "DoorControlPort", + "description": "This operation allows releasing the LockedOpen state of a Door. The DoorMode shall change state from the LockedOpen state back to its previous/next state. It is not defined what the previous/next state shall be, but typically - Unlocked. A device that signals support for LockOpen capability for a particular Door instance shall support this command. This method shall only succeed if the current DoorMode is LockedOpen.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockOpenReleaseDoorRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockOpenReleaseDoor", + "schema": { + "name": "LockOpenReleaseDoor", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Door instance to control." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockOpenReleaseDoorResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}LockOpenReleaseDoorResponse", + "schema": { + "name": "LockOpenReleaseDoorResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + }, + { + "name": "DoubleLockDoor", + "port_type": "DoorControlPort", + "description": "This operation is used for securely locking a Door. A call to this method shall change DoorMode state to DoubleLocked. Please refer to DoubleLocked mode in section [DoorMode] for more details. A device that signals support for DoubleLock capability for a particular Door instance shall implement this method. Otherwise this method can be performed as a standard Lock operation (see [LockDoor command]). If the door has an extra lock that shall be locked as well. If the request cannot be fulfilled, a Failure fault shall be returned.", + "input": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoubleLockDoorRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoubleLockDoor", + "schema": { + "name": "DoubleLockDoor", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Door instance to control." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoubleLockDoorResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/doorcontrol/wsdl}DoubleLockDoorResponse", + "schema": { + "name": "DoubleLockDoorResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "DoorControlBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/provisioning/wsdl/provisioning.json b/docs/generated/wsdl/ver10/provisioning/wsdl/provisioning.json new file mode 100644 index 00000000..489a3cb0 --- /dev/null +++ b/docs/generated/wsdl/ver10/provisioning/wsdl/provisioning.json @@ -0,0 +1,853 @@ +{ + "source": "ver10/provisioning/wsdl/provisioning.wsdl", + "target_namespace": "http://www.onvif.org/ver10/provisioning/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "ProvisioningService", + "description": "Returns the capabilities of the provisioning service.", + "input": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/provisioning/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "description": "The capabilities of Provisioning Service on the device.", + "fields": [ + { + "name": "DefaultTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum time before stopping movement after a move operation." + }, + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/provisioning/wsdl}SourceCapabilities", + "type_name": "SourceCapabilities", + "definition": { + "kind": "complexType", + "name": "SourceCapabilities", + "description": "The provisioning capabilities of a video source on the device.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of a video source." + }, + { + "use": "optional", + "name": "MaximumPanMoves", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "description": "Lifetime limit of pan moves for this video source. Presence of this attribute indicates support of pan move." + }, + { + "use": "optional", + "name": "MaximumTiltMoves", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "description": "Lifetime limit of tilt moves for this video source. Presence of this attribute indicates support of tilt move." + }, + { + "use": "optional", + "name": "MaximumZoomMoves", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "description": "Lifetime limit of zoom moves for this video source. Presence of this attribute indicates support of zoom move." + }, + { + "use": "optional", + "name": "MaximumRollMoves", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "description": "Lifetime limit of roll moves for this video source. Presence of this attribute indicates support of roll move." + }, + { + "use": "optional", + "name": "AutoLevel", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates \"auto\" as a valid enum for Direction in RollMove." + }, + { + "use": "optional", + "name": "MaximumFocusMoves", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "description": "Lifetime limit of focus moves for this video source. Presence of this attribute indicates support of focus move." + }, + { + "use": "optional", + "name": "AutoFocus", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates \"auto\" as a valid enum for Direction in FocusMove." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Capabilities per video source." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the provisioning service on this device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ProvisioningBinding" + }, + { + "name": "PanMove", + "port_type": "ProvisioningService", + "description": "Moves device on the pan axis.", + "input": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}PanMoveRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}PanMove", + "schema": { + "name": "PanMove", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSource", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The video source associated with the provisioning." + }, + { + "name": "Direction", + "type": "{http://www.onvif.org/ver10/provisioning/wsdl}PanDirection", + "type_name": "PanDirection", + "definition": { + "kind": "simpleType", + "name": "PanDirection", + "description": "The direction for PanMove to move the device.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Left", + "description": "Move left in relation to the video source image." + }, + { + "value": "Right", + "description": "Move right in relation to the video source image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "\"left\" or \"right\"." + }, + { + "name": "Timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "\"Operation timeout, if less than default timeout." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}PanMoveResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}PanMoveResponse", + "schema": { + "name": "PanMoveResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ProvisioningBinding" + }, + { + "name": "TiltMove", + "port_type": "ProvisioningService", + "description": "Moves device on the tilt axis.", + "input": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}TiltMoveRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}TiltMove", + "schema": { + "name": "TiltMove", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSource", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The video source associated with the provisioning." + }, + { + "name": "Direction", + "type": "{http://www.onvif.org/ver10/provisioning/wsdl}TiltDirection", + "type_name": "TiltDirection", + "definition": { + "kind": "simpleType", + "name": "TiltDirection", + "description": "The direction for TiltMove to move the device.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Up", + "description": "Move up in relation to the video source image." + }, + { + "value": "Down", + "description": "Move down in relation to the video source image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "\"up\" or \"down\"." + }, + { + "name": "Timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "\"Operation timeout, if less than default timeout." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}TiltMoveResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}TiltMoveResponse", + "schema": { + "name": "TiltMoveResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ProvisioningBinding" + }, + { + "name": "ZoomMove", + "port_type": "ProvisioningService", + "description": "Moves device on the zoom axis.", + "input": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}ZoomMoveRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}ZoomMove", + "schema": { + "name": "ZoomMove", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSource", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The video source associated with the provisioning." + }, + { + "name": "Direction", + "type": "{http://www.onvif.org/ver10/provisioning/wsdl}ZoomDirection", + "type_name": "ZoomDirection", + "definition": { + "kind": "simpleType", + "name": "ZoomDirection", + "description": "The direction for ZoomMove to change the focal length in relation to the video source.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Wide", + "description": "Move video source lens toward a wider field of view." + }, + { + "value": "Telephoto", + "description": "Move video source lens toward a narrower field of view." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "\"wide\" or \"telephoto\"." + }, + { + "name": "Timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "\"Operation timeout, if less than default timeout." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}ZoomMoveResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}ZoomMoveResponse", + "schema": { + "name": "ZoomMoveResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ProvisioningBinding" + }, + { + "name": "RollMove", + "port_type": "ProvisioningService", + "description": "Moves device on the roll axis.", + "input": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}RollMoveRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}RollMove", + "schema": { + "name": "RollMove", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSource", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The video source associated with the provisioning." + }, + { + "name": "Direction", + "type": "{http://www.onvif.org/ver10/provisioning/wsdl}RollDirection", + "type_name": "RollDirection", + "definition": { + "kind": "simpleType", + "name": "RollDirection", + "description": "The direction for RollMove to move the device.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Clockwise", + "description": "Move clockwise in relation to the video source image." + }, + { + "value": "Counterclockwise", + "description": "Move counterclockwise in relation to the video source image." + }, + { + "value": "Auto", + "description": "Automatically level the device in relation to the video source image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "\"clockwise\", \"counterclockwise\", or \"auto\"." + }, + { + "name": "Timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "\"Operation timeout, if less than default timeout." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}RollMoveResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}RollMoveResponse", + "schema": { + "name": "RollMoveResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ProvisioningBinding" + }, + { + "name": "FocusMove", + "port_type": "ProvisioningService", + "description": "Moves device on the focus axis.", + "input": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}FocusMoveRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}FocusMove", + "schema": { + "name": "FocusMove", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSource", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The video source associated with the provisioning." + }, + { + "name": "Direction", + "type": "{http://www.onvif.org/ver10/provisioning/wsdl}FocusDirection", + "type_name": "FocusDirection", + "definition": { + "kind": "simpleType", + "name": "FocusDirection", + "description": "The direction for FocusMove to move the focal plane in relation to the video source.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Near", + "description": "Move to focus on close objects." + }, + { + "value": "Far", + "description": "Move to focus on distant objects." + }, + { + "value": "Auto", + "description": "Automatically focus for the sharpest video source image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "\"near\", \"far\", or \"auto\"." + }, + { + "name": "Timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "\"Operation timeout, if less than default timeout." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}FocusMoveResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}FocusMoveResponse", + "schema": { + "name": "FocusMoveResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ProvisioningBinding" + }, + { + "name": "Stop", + "port_type": "ProvisioningService", + "description": "Stops device motion on all axes.", + "input": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}StopRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}Stop", + "schema": { + "name": "Stop", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSource", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The video source associated with the provisioning." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}StopResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}StopResponse", + "schema": { + "name": "StopResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ProvisioningBinding" + }, + { + "name": "GetUsage", + "port_type": "ProvisioningService", + "description": "Returns the lifetime move counts.", + "input": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}GetUsageRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}GetUsage", + "schema": { + "name": "GetUsage", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSource", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The video source associated with the provisioning." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/provisioning/wsdl}GetUsageResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/provisioning/wsdl}GetUsageResponse", + "schema": { + "name": "GetUsageResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Usage", + "type": "{http://www.onvif.org/ver10/provisioning/wsdl}Usage", + "type_name": "Usage", + "definition": { + "kind": "complexType", + "name": "Usage", + "description": "The quantity of movement events that have occured over the lifetime of the device.", + "fields": [ + { + "name": "Pan", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The quantity of pan movement events over the life of the device." + }, + { + "name": "Tilt", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The quantity of tilt movement events over the life of the device." + }, + { + "name": "Zoom", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The quantity of zoom movement events over the life of the device." + }, + { + "name": "Roll", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The quantity of roll movement events over the life of the device." + }, + { + "name": "Focus", + "type": "{http://www.w3.org/2001/XMLSchema}positiveInteger", + "type_name": "positiveInteger", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The quantity of focus movement events over the life of the device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The set of lifetime usage values for the provisioning associated with the video source." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ProvisioningBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/receiver.json b/docs/generated/wsdl/ver10/receiver.json new file mode 100644 index 00000000..7f204a84 --- /dev/null +++ b/docs/generated/wsdl/ver10/receiver.json @@ -0,0 +1,1645 @@ +{ + "source": "ver10/receiver.wsdl", + "target_namespace": "http://www.onvif.org/ver10/receiver/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "ReceiverPort", + "description": "Returns the capabilities of the receiver service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/receiver/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "RTP_Multicast", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that the device can receive RTP multicast streams." + }, + { + "use": "optional", + "name": "RTP_TCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that the device can receive RTP/TCP streams" + }, + { + "use": "optional", + "name": "RTP_RTSP_TCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that the device can receive RTP/RTSP/TCP streams." + }, + { + "use": "required", + "name": "SupportedReceivers", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The maximum number of receivers supported by the device." + }, + { + "use": "optional", + "name": "MaximumRTSPURILength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The maximum allowed length for RTSP URIs (Minimum and default value is 128 octet)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the receiver service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ReceiverBinding" + }, + { + "name": "GetReceivers", + "port_type": "ReceiverPort", + "description": "Lists all receivers currently present on a device. This operation is mandatory.", + "input": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}GetReceiversRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}GetReceivers", + "schema": { + "name": "GetReceivers", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}GetReceiversResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}GetReceiversResponse", + "schema": { + "name": "GetReceiversResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Receivers", + "type": "{http://www.onvif.org/ver10/schema}Receiver", + "type_name": "Receiver", + "definition": { + "kind": "complexType", + "name": "Receiver", + "description": "Description of a receiver, including its token and configuration.", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique identifier of the receiver." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}ReceiverConfiguration", + "type_name": "ReceiverConfiguration", + "definition": { + "kind": "complexType", + "name": "ReceiverConfiguration", + "description": "Describes the configuration of a receiver.", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReceiverMode", + "type_name": "ReceiverMode", + "definition": { + "kind": "simpleType", + "name": "ReceiverMode", + "description": "Specifies a receiver connection mode.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AutoConnect", + "description": "The receiver connects on demand, as required by consumers of the media streams." + }, + { + "value": "AlwaysConnect", + "description": "The receiver attempts to maintain a persistent connection to the configured endpoint." + }, + { + "value": "NeverConnect", + "description": "The receiver does not attempt to connect." + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The following connection modes are defined:" + }, + { + "name": "MediaUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Details of the URI to which the receiver should connect." + }, + { + "name": "StreamSetup", + "type": "{http://www.onvif.org/ver10/schema}StreamSetup", + "type_name": "StreamSetup", + "definition": { + "kind": "complexType", + "name": "StreamSetup", + "fields": [ + { + "name": "Stream", + "type": "{http://www.onvif.org/ver10/schema}StreamType", + "type_name": "StreamType", + "definition": { + "kind": "simpleType", + "name": "StreamType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "RTP-Unicast" + }, + { + "value": "RTP-Multicast" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines if a multicast or unicast stream is requested." + }, + { + "name": "Transport", + "type": "{http://www.onvif.org/ver10/schema}Transport", + "type_name": "Transport", + "definition": { + "kind": "complexType", + "name": "Transport", + "fields": [ + { + "name": "Protocol", + "type": "{http://www.onvif.org/ver10/schema}TransportProtocol", + "type_name": "TransportProtocol", + "definition": { + "kind": "simpleType", + "name": "TransportProtocol", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "UDP" + }, + { + "value": "TCP", + "description": "This value is deprecated." + }, + { + "value": "RTSP" + }, + { + "value": "HTTP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP." + }, + { + "name": "Tunnel", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Deprecated: optional element to describe further tunnel options." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Stream connection parameters." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Describes the configuration of the receiver." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of all receivers that currently exist on the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ReceiverBinding" + }, + { + "name": "GetReceiver", + "port_type": "ReceiverPort", + "description": "Retrieves the details of a specific receiver. This operation is mandatory.", + "input": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}GetReceiverRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}GetReceiver", + "schema": { + "name": "GetReceiver", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the receiver to be retrieved." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}GetReceiverResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}GetReceiverResponse", + "schema": { + "name": "GetReceiverResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Receiver", + "type": "{http://www.onvif.org/ver10/schema}Receiver", + "type_name": "Receiver", + "definition": { + "kind": "complexType", + "name": "Receiver", + "description": "Description of a receiver, including its token and configuration.", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique identifier of the receiver." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}ReceiverConfiguration", + "type_name": "ReceiverConfiguration", + "definition": { + "kind": "complexType", + "name": "ReceiverConfiguration", + "description": "Describes the configuration of a receiver.", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReceiverMode", + "type_name": "ReceiverMode", + "definition": { + "kind": "simpleType", + "name": "ReceiverMode", + "description": "Specifies a receiver connection mode.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AutoConnect", + "description": "The receiver connects on demand, as required by consumers of the media streams." + }, + { + "value": "AlwaysConnect", + "description": "The receiver attempts to maintain a persistent connection to the configured endpoint." + }, + { + "value": "NeverConnect", + "description": "The receiver does not attempt to connect." + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The following connection modes are defined:" + }, + { + "name": "MediaUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Details of the URI to which the receiver should connect." + }, + { + "name": "StreamSetup", + "type": "{http://www.onvif.org/ver10/schema}StreamSetup", + "type_name": "StreamSetup", + "definition": { + "kind": "complexType", + "name": "StreamSetup", + "fields": [ + { + "name": "Stream", + "type": "{http://www.onvif.org/ver10/schema}StreamType", + "type_name": "StreamType", + "definition": { + "kind": "simpleType", + "name": "StreamType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "RTP-Unicast" + }, + { + "value": "RTP-Multicast" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines if a multicast or unicast stream is requested." + }, + { + "name": "Transport", + "type": "{http://www.onvif.org/ver10/schema}Transport", + "type_name": "Transport", + "definition": { + "kind": "complexType", + "name": "Transport", + "fields": [ + { + "name": "Protocol", + "type": "{http://www.onvif.org/ver10/schema}TransportProtocol", + "type_name": "TransportProtocol", + "definition": { + "kind": "simpleType", + "name": "TransportProtocol", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "UDP" + }, + { + "value": "TCP", + "description": "This value is deprecated." + }, + { + "value": "RTSP" + }, + { + "value": "HTTP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP." + }, + { + "name": "Tunnel", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Deprecated: optional element to describe further tunnel options." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Stream connection parameters." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Describes the configuration of the receiver." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The details of the receiver." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ReceiverBinding" + }, + { + "name": "CreateReceiver", + "port_type": "ReceiverPort", + "description": "Creates a new receiver. This operation is mandatory, although the service may raise a fault if the receiver cannot be created.", + "input": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}CreateReceiverRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}CreateReceiver", + "schema": { + "name": "CreateReceiver", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}ReceiverConfiguration", + "type_name": "ReceiverConfiguration", + "definition": { + "kind": "complexType", + "name": "ReceiverConfiguration", + "description": "Describes the configuration of a receiver.", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReceiverMode", + "type_name": "ReceiverMode", + "definition": { + "kind": "simpleType", + "name": "ReceiverMode", + "description": "Specifies a receiver connection mode.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AutoConnect", + "description": "The receiver connects on demand, as required by consumers of the media streams." + }, + { + "value": "AlwaysConnect", + "description": "The receiver attempts to maintain a persistent connection to the configured endpoint." + }, + { + "value": "NeverConnect", + "description": "The receiver does not attempt to connect." + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The following connection modes are defined:" + }, + { + "name": "MediaUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Details of the URI to which the receiver should connect." + }, + { + "name": "StreamSetup", + "type": "{http://www.onvif.org/ver10/schema}StreamSetup", + "type_name": "StreamSetup", + "definition": { + "kind": "complexType", + "name": "StreamSetup", + "fields": [ + { + "name": "Stream", + "type": "{http://www.onvif.org/ver10/schema}StreamType", + "type_name": "StreamType", + "definition": { + "kind": "simpleType", + "name": "StreamType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "RTP-Unicast" + }, + { + "value": "RTP-Multicast" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines if a multicast or unicast stream is requested." + }, + { + "name": "Transport", + "type": "{http://www.onvif.org/ver10/schema}Transport", + "type_name": "Transport", + "definition": { + "kind": "complexType", + "name": "Transport", + "fields": [ + { + "name": "Protocol", + "type": "{http://www.onvif.org/ver10/schema}TransportProtocol", + "type_name": "TransportProtocol", + "definition": { + "kind": "simpleType", + "name": "TransportProtocol", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "UDP" + }, + { + "value": "TCP", + "description": "This value is deprecated." + }, + { + "value": "RTSP" + }, + { + "value": "HTTP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP." + }, + { + "name": "Tunnel", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Deprecated: optional element to describe further tunnel options." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Stream connection parameters." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The initial configuration for the new receiver." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}CreateReceiverResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}CreateReceiverResponse", + "schema": { + "name": "CreateReceiverResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Receiver", + "type": "{http://www.onvif.org/ver10/schema}Receiver", + "type_name": "Receiver", + "definition": { + "kind": "complexType", + "name": "Receiver", + "description": "Description of a receiver, including its token and configuration.", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique identifier of the receiver." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}ReceiverConfiguration", + "type_name": "ReceiverConfiguration", + "definition": { + "kind": "complexType", + "name": "ReceiverConfiguration", + "description": "Describes the configuration of a receiver.", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReceiverMode", + "type_name": "ReceiverMode", + "definition": { + "kind": "simpleType", + "name": "ReceiverMode", + "description": "Specifies a receiver connection mode.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AutoConnect", + "description": "The receiver connects on demand, as required by consumers of the media streams." + }, + { + "value": "AlwaysConnect", + "description": "The receiver attempts to maintain a persistent connection to the configured endpoint." + }, + { + "value": "NeverConnect", + "description": "The receiver does not attempt to connect." + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The following connection modes are defined:" + }, + { + "name": "MediaUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Details of the URI to which the receiver should connect." + }, + { + "name": "StreamSetup", + "type": "{http://www.onvif.org/ver10/schema}StreamSetup", + "type_name": "StreamSetup", + "definition": { + "kind": "complexType", + "name": "StreamSetup", + "fields": [ + { + "name": "Stream", + "type": "{http://www.onvif.org/ver10/schema}StreamType", + "type_name": "StreamType", + "definition": { + "kind": "simpleType", + "name": "StreamType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "RTP-Unicast" + }, + { + "value": "RTP-Multicast" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines if a multicast or unicast stream is requested." + }, + { + "name": "Transport", + "type": "{http://www.onvif.org/ver10/schema}Transport", + "type_name": "Transport", + "definition": { + "kind": "complexType", + "name": "Transport", + "fields": [ + { + "name": "Protocol", + "type": "{http://www.onvif.org/ver10/schema}TransportProtocol", + "type_name": "TransportProtocol", + "definition": { + "kind": "simpleType", + "name": "TransportProtocol", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "UDP" + }, + { + "value": "TCP", + "description": "This value is deprecated." + }, + { + "value": "RTSP" + }, + { + "value": "HTTP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP." + }, + { + "name": "Tunnel", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Deprecated: optional element to describe further tunnel options." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Stream connection parameters." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Describes the configuration of the receiver." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The details of the receiver that was created." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ReceiverBinding" + }, + { + "name": "DeleteReceiver", + "port_type": "ReceiverPort", + "description": "Deletes an existing receiver. A receiver may be deleted only if it is not currently in use; otherwise a fault shall be raised. This operation is mandatory.", + "input": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}DeleteReceiverRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}DeleteReceiver", + "schema": { + "name": "DeleteReceiver", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the receiver to be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}DeleteReceiverResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}DeleteReceiverResponse", + "schema": { + "name": "DeleteReceiverResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ReceiverBinding" + }, + { + "name": "ConfigureReceiver", + "port_type": "ReceiverPort", + "description": "Configures an existing receiver. This operation is mandatory.", + "input": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}ConfigureReceiverRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}ConfigureReceiver", + "schema": { + "name": "ConfigureReceiver", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the receiver to be configured." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}ReceiverConfiguration", + "type_name": "ReceiverConfiguration", + "definition": { + "kind": "complexType", + "name": "ReceiverConfiguration", + "description": "Describes the configuration of a receiver.", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReceiverMode", + "type_name": "ReceiverMode", + "definition": { + "kind": "simpleType", + "name": "ReceiverMode", + "description": "Specifies a receiver connection mode.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AutoConnect", + "description": "The receiver connects on demand, as required by consumers of the media streams." + }, + { + "value": "AlwaysConnect", + "description": "The receiver attempts to maintain a persistent connection to the configured endpoint." + }, + { + "value": "NeverConnect", + "description": "The receiver does not attempt to connect." + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The following connection modes are defined:" + }, + { + "name": "MediaUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Details of the URI to which the receiver should connect." + }, + { + "name": "StreamSetup", + "type": "{http://www.onvif.org/ver10/schema}StreamSetup", + "type_name": "StreamSetup", + "definition": { + "kind": "complexType", + "name": "StreamSetup", + "fields": [ + { + "name": "Stream", + "type": "{http://www.onvif.org/ver10/schema}StreamType", + "type_name": "StreamType", + "definition": { + "kind": "simpleType", + "name": "StreamType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "RTP-Unicast" + }, + { + "value": "RTP-Multicast" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines if a multicast or unicast stream is requested." + }, + { + "name": "Transport", + "type": "{http://www.onvif.org/ver10/schema}Transport", + "type_name": "Transport", + "definition": { + "kind": "complexType", + "name": "Transport", + "fields": [ + { + "name": "Protocol", + "type": "{http://www.onvif.org/ver10/schema}TransportProtocol", + "type_name": "TransportProtocol", + "definition": { + "kind": "simpleType", + "name": "TransportProtocol", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "UDP" + }, + { + "value": "TCP", + "description": "This value is deprecated." + }, + { + "value": "RTSP" + }, + { + "value": "HTTP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP." + }, + { + "name": "Tunnel", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Deprecated: optional element to describe further tunnel options." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Stream connection parameters." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The new configuration for the receiver." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}ConfigureReceiverResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}ConfigureReceiverResponse", + "schema": { + "name": "ConfigureReceiverResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ReceiverBinding" + }, + { + "name": "SetReceiverMode", + "port_type": "ReceiverPort", + "description": "Sets the mode of the receiver without affecting the rest of its configuration. This operation is mandatory.", + "input": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}SetReceiverModeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}SetReceiverMode", + "schema": { + "name": "SetReceiverMode", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the receiver to be changed." + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReceiverMode", + "type_name": "ReceiverMode", + "definition": { + "kind": "simpleType", + "name": "ReceiverMode", + "description": "Specifies a receiver connection mode.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AutoConnect", + "description": "The receiver connects on demand, as required by consumers of the media streams." + }, + { + "value": "AlwaysConnect", + "description": "The receiver attempts to maintain a persistent connection to the configured endpoint." + }, + { + "value": "NeverConnect", + "description": "The receiver does not attempt to connect." + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The new receiver mode. Options available are:" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}SetReceiverModeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}SetReceiverModeResponse", + "schema": { + "name": "SetReceiverModeResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ReceiverBinding" + }, + { + "name": "GetReceiverState", + "port_type": "ReceiverPort", + "description": "Determines whether the receiver is currently disconnected, connected or attempting to connect. This operation is mandatory.", + "input": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}GetReceiverStateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}GetReceiverState", + "schema": { + "name": "GetReceiverState", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ReceiverToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the receiver to be queried." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/receiver/wsdl}GetReceiverStateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/receiver/wsdl}GetReceiverStateResponse", + "schema": { + "name": "GetReceiverStateResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ReceiverState", + "type": "{http://www.onvif.org/ver10/schema}ReceiverStateInformation", + "type_name": "ReceiverStateInformation", + "definition": { + "kind": "complexType", + "name": "ReceiverStateInformation", + "description": "Contains information about a receiver's current state.", + "fields": [ + { + "name": "State", + "type": "{http://www.onvif.org/ver10/schema}ReceiverState", + "type_name": "ReceiverState", + "definition": { + "kind": "simpleType", + "name": "ReceiverState", + "description": "Specifies the current connection state of the receiver.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "NotConnected", + "description": "The receiver is not connected." + }, + { + "value": "Connecting", + "description": "The receiver is attempting to connect." + }, + { + "value": "Connected", + "description": "The receiver is connected." + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The connection state of the receiver may have one of the following states:" + }, + { + "name": "AutoCreated", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not the receiver was created automatically." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Description of the current receiver state." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ReceiverBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/recording.json b/docs/generated/wsdl/ver10/recording.json new file mode 100644 index 00000000..12811bfa --- /dev/null +++ b/docs/generated/wsdl/ver10/recording.json @@ -0,0 +1,6858 @@ +{ + "source": "ver10/recording.wsdl", + "target_namespace": "http://www.onvif.org/ver10/recording/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "RecordingPort", + "description": "Returns the capabilities of the recording service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/recording/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "DynamicRecordings", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication if the device supports dynamic creation and deletion of recordings" + }, + { + "use": "optional", + "name": "DynamicTracks", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication if the device supports dynamic creation and deletion of tracks" + }, + { + "use": "optional", + "name": "Encoding", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Indication which encodings are supported for recording. The list may contain one or more enumeration values of tt:VideoEncoding and tt:AudioEncoding. For encodings that are neither defined in tt:VideoEncoding nor tt:AudioEncoding the device shall use the IANA defintions. Note, that a device without audio support shall not return audio encodings." + }, + { + "use": "optional", + "name": "MaxRate", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Maximum supported bit rate for all tracks of a recording in kBit/s." + }, + { + "use": "optional", + "name": "MaxTotalRate", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Maximum supported bit rate for all recordings in kBit/s." + }, + { + "use": "optional", + "name": "MaxRecordings", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Maximum number of recordings supported. (Integer values only.)" + }, + { + "use": "optional", + "name": "MaxRecordingJobs", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum total number of supported recording jobs by the device." + }, + { + "use": "optional", + "name": "Options", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication if the device supports the GetRecordingOptions command." + }, + { + "use": "optional", + "name": "MetadataRecording", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication if the device supports recording metadata." + }, + { + "use": "optional", + "name": "SupportedExportFileFormats", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Indication that the device supports ExportRecordedData command for the listed export file formats.\n\t\t\t\t\t\tThe list shall return at least one export file format value. The value of 'ONVIF' refers to\n\t\t\t\t\t\tONVIF Export File Format specification." + }, + { + "use": "optional", + "name": "EventRecording", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication that the device supports event triggered recording." + }, + { + "use": "optional", + "name": "BeforeEventLimit", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "description": "If present a device shall support configuring before event durations up to the given value." + }, + { + "use": "optional", + "name": "AfterEventLimit", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "description": "If present a device shall support configuring after event durations up to the given value." + }, + { + "use": "optional", + "name": "SupportedTargetFormats", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of formats supported by the device for recording to an external target.\n\t\t\t\t\t\t\tSee tt:TargetFormat for a list of definitions." + }, + { + "use": "optional", + "name": "EncryptionEntryLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Number of encryption entries supported per recording.\n\t\t\t\t\t\t\tBy specifying multiple encryption entries per recording, different tracks can be encrypted with different configurations." + }, + { + "use": "optional", + "name": "SupportedEncryptionModes", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Indicates supported encryption modes.\n\t\t\t\t\t\t\tSee tt:EncryptionMode for a list of definitions." + }, + { + "use": "optional", + "name": "OverrideSegmentDuration", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates if the device supports the OverrideSegmentDuration command." + }, + { + "use": "optional", + "name": "AsymmetricEncryptionSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates if the device supports asymmetric encryption." + }, + { + "use": "optional", + "name": "ScheduledRecording", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates if the device supports scheduled recording." + }, + { + "use": "optional", + "name": "OnboardStorage", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "true", + "description": "Indicates if the device supports recording to onboard storage, default value is true. If false, device shall support recording to an external target." + }, + { + "use": "optional", + "name": "SegmentExport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for ExportRecordedSegments." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the recording service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "CreateRecording", + "port_type": "RecordingPort", + "description": "CreateRecording shall create a new recording. The new recording shall be created with a track for each supported TrackType see Recording Control Spec. This method is optional. It shall be available if the Recording/DynamicRecordings capability is TRUE. When successfully completed, CreateRecording shall have created three tracks with the following configurations: TrackToken TrackType VIDEO001 Video AUDIO001 Audio META001 Metadata The created recording shall have MaximumRetentionTime set to the value specified in the RecordingConfiguration supplied to CreateRecording. If that value is PT0S, the recording shall have unlimited retention. All tracks created as part of the request shall have the Description set to the empty string by default.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}CreateRecordingRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}CreateRecording", + "schema": { + "name": "CreateRecording", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RecordingConfiguration", + "type_name": "RecordingConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingConfiguration", + "fields": [ + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}RecordingSourceInformation", + "type_name": "RecordingSourceInformation", + "definition": { + "kind": "complexType", + "name": "RecordingSourceInformation", + "description": "A set of informative descriptions of a data source. The Search service allows a client to filter on recordings based on information in this structure.", + "fields": [ + { + "name": "SourceId", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifier for the source chosen by the client that creates the structure.\n\t\t\t\tThis identifier is opaque to the device. Clients may use any type of URI for this field. A device shall support at least 128 characters." + }, + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative user readable name of the source, e.g. \"Camera23\". A device shall support at least 20 characters." + }, + { + "name": "Location", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the physical location of the source, e.g. the coordinates on a map." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the source." + }, + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "URI provided by the service supplying data to be recorded. A device shall support at least 128 characters." + }, + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The video source token of all recordings that will use this configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Information about the source of the recording." + }, + { + "name": "Content", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the source." + }, + { + "name": "MaximumRetentionTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the maximum time that data in any track within the\n\t\t\t\trecording shall be stored. The device shall delete any data older than the maximum retention\n\t\t\t\ttime. Such data shall not be accessible anymore. If the MaximumRetentionPeriod is set to 0,\n\t\t\t\tthe device shall not limit the retention time of stored data, except by resource constraints.\n\t\t\t\tWhatever the value of MaximumRetentionTime, the device may automatically delete\n\t\t\t\trecordings to free up storage space for new recordings. This parameter has no effect on the data stored in external targets for e.g. Object Storage." + }, + { + "name": "Target", + "type": "{http://www.onvif.org/ver10/schema}RecordingTargetConfiguration", + "type_name": "RecordingTargetConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingTargetConfiguration", + "fields": [ + { + "name": "Storage", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of a storage configuration." + }, + { + "name": "Format", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Format of the recording.\n\t\t\t\t\t\tSee tt:TargetFormat for a list of definitions and capability trc:SupportedTargetFormats for the supported formats." + }, + { + "name": "Prefix", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Path prefix to be inserted in the object key. A device shall support at least 128 characters." + }, + { + "name": "Postfix", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Path postfix to be inserted in the object key. A device shall support at least 128 characters." + }, + { + "name": "SpanDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum duration of a span." + }, + { + "name": "SegmentDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum duration of a segment." + }, + { + "name": "Encryption", + "type": "{http://www.onvif.org/ver10/schema}RecordingEncryption", + "type_name": "RecordingEncryption", + "definition": { + "kind": "complexType", + "name": "RecordingEncryption", + "fields": [ + { + "name": "KID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Key ID of the associated key for encryption, formatted as a UUID according to RFC 9562 Section 4. The client shall omit this parameter when AsymmetricEncryption is configured." + }, + { + "name": "Key", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Key for encrypting content. The client shall omit this parameter when AsymmetricEncryption is configured.\n\t\t\t\t\t\tThe device shall not include this parameter when reading." + }, + { + "name": "Track", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional list of track tokens to be encrypted.\n\t\t\t\t\t\tIf no track tokens are specified, all tracks are encrypted and no other encryption configurations shall exist for the recording.\n\t\t\t\t\t\tEach track shall only be contained in one encryption configuration." + }, + { + "name": "AsymmetricEncryption", + "type": "{http://www.onvif.org/ver10/schema}AsymmetricEncryption", + "type_name": "AsymmetricEncryption", + "definition": { + "kind": "complexType", + "name": "AsymmetricEncryption", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of certificates used to encrypt the symmetric key for the PSSH box." + }, + { + "name": "KeyRotationDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Frequency at which the device shall generate a new key to encrypt a new segment.\n\t\t\t\t\tIf not specified, key rotation is disabled.\n\t\t\t\t\tKeyRotationDuration must be a positive duration value." + }, + { + "name": "AdditionalInfo", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Additional information related to the asymmetric encryption that will be used as\n\t\t\t\t\t\tpart of the key encryption. A device shall support at least 256 characters." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Mode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Mode of encryption.\n\t\t\t\t\tSee tt:EncryptionMode for a list of definitions and capability trc:SupportedEncryptionModes for the supported encryption modes." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional encryption configuration.\n\t\t\t\t\t\tSee capability trc:EncryptionEntryLimit for the number of supported entries.\n\t\t\t\t\t\tBy specifying multiple encryption entries per recording, different tracks can be encrypted with different configurations.\n\t\t\t\t\t\tEach track shall only be contained in one encryption configuration." + }, + { + "name": "SegmentDurationOverride", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Duration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current value of the segment duration." + }, + { + "name": "Expiration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Time remaining until the override expires." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Value of the active OverrideSegmentDuration parameters if one exists. (readonly)" + }, + { + "name": "StorageStrategy", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Strategy to be used on how to store recordings, see tt:StorageStrategy for allowed values. If undefined, defaults to External." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional external storage target configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Initial configuration for the recording." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}CreateRecordingResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}CreateRecordingResponse", + "schema": { + "name": "CreateRecordingResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The reference to the created recording." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "DeleteRecording", + "port_type": "RecordingPort", + "description": "DeleteRecording shall delete a recording object. Whenever a recording is deleted, the device shall delete all the tracks that are part of the recording, and it shall delete all the Recording Jobs that record into the recording. For each deleted recording job, the device shall also delete all the receiver objects associated with the recording job that are automatically created using the AutoCreateReceiver field of the recording job configuration structure and are not used in any other recording job. This method is optional. It shall be available if the Recording/DynamicRecordings capability is TRUE.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}DeleteRecordingRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}DeleteRecording", + "schema": { + "name": "DeleteRecording", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The reference of the recording to be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}DeleteRecordingResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}DeleteRecordingResponse", + "schema": { + "name": "DeleteRecordingResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "GetRecordings", + "port_type": "RecordingPort", + "description": "GetRecordings shall return a description of all the recordings in the device. This description shall include a list of all the tracks for each recording.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordings", + "schema": { + "name": "GetRecordings", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingsResponse", + "schema": { + "name": "GetRecordingsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingItem", + "type": "{http://www.onvif.org/ver10/schema}GetRecordingsResponseItem", + "type_name": "GetRecordingsResponseItem", + "definition": { + "kind": "complexType", + "name": "GetRecordingsResponseItem", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the recording." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}RecordingConfiguration", + "type_name": "RecordingConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingConfiguration", + "fields": [ + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}RecordingSourceInformation", + "type_name": "RecordingSourceInformation", + "definition": { + "kind": "complexType", + "name": "RecordingSourceInformation", + "description": "A set of informative descriptions of a data source. The Search service allows a client to filter on recordings based on information in this structure.", + "fields": [ + { + "name": "SourceId", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifier for the source chosen by the client that creates the structure.\n\t\t\t\tThis identifier is opaque to the device. Clients may use any type of URI for this field. A device shall support at least 128 characters." + }, + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative user readable name of the source, e.g. \"Camera23\". A device shall support at least 20 characters." + }, + { + "name": "Location", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the physical location of the source, e.g. the coordinates on a map." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the source." + }, + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "URI provided by the service supplying data to be recorded. A device shall support at least 128 characters." + }, + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The video source token of all recordings that will use this configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Information about the source of the recording." + }, + { + "name": "Content", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the source." + }, + { + "name": "MaximumRetentionTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the maximum time that data in any track within the\n\t\t\t\trecording shall be stored. The device shall delete any data older than the maximum retention\n\t\t\t\ttime. Such data shall not be accessible anymore. If the MaximumRetentionPeriod is set to 0,\n\t\t\t\tthe device shall not limit the retention time of stored data, except by resource constraints.\n\t\t\t\tWhatever the value of MaximumRetentionTime, the device may automatically delete\n\t\t\t\trecordings to free up storage space for new recordings. This parameter has no effect on the data stored in external targets for e.g. Object Storage." + }, + { + "name": "Target", + "type": "{http://www.onvif.org/ver10/schema}RecordingTargetConfiguration", + "type_name": "RecordingTargetConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingTargetConfiguration", + "fields": [ + { + "name": "Storage", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of a storage configuration." + }, + { + "name": "Format", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Format of the recording.\n\t\t\t\t\t\tSee tt:TargetFormat for a list of definitions and capability trc:SupportedTargetFormats for the supported formats." + }, + { + "name": "Prefix", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Path prefix to be inserted in the object key. A device shall support at least 128 characters." + }, + { + "name": "Postfix", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Path postfix to be inserted in the object key. A device shall support at least 128 characters." + }, + { + "name": "SpanDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum duration of a span." + }, + { + "name": "SegmentDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum duration of a segment." + }, + { + "name": "Encryption", + "type": "{http://www.onvif.org/ver10/schema}RecordingEncryption", + "type_name": "RecordingEncryption", + "definition": { + "kind": "complexType", + "name": "RecordingEncryption", + "fields": [ + { + "name": "KID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Key ID of the associated key for encryption, formatted as a UUID according to RFC 9562 Section 4. The client shall omit this parameter when AsymmetricEncryption is configured." + }, + { + "name": "Key", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Key for encrypting content. The client shall omit this parameter when AsymmetricEncryption is configured.\n\t\t\t\t\t\tThe device shall not include this parameter when reading." + }, + { + "name": "Track", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional list of track tokens to be encrypted.\n\t\t\t\t\t\tIf no track tokens are specified, all tracks are encrypted and no other encryption configurations shall exist for the recording.\n\t\t\t\t\t\tEach track shall only be contained in one encryption configuration." + }, + { + "name": "AsymmetricEncryption", + "type": "{http://www.onvif.org/ver10/schema}AsymmetricEncryption", + "type_name": "AsymmetricEncryption", + "definition": { + "kind": "complexType", + "name": "AsymmetricEncryption", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of certificates used to encrypt the symmetric key for the PSSH box." + }, + { + "name": "KeyRotationDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Frequency at which the device shall generate a new key to encrypt a new segment.\n\t\t\t\t\tIf not specified, key rotation is disabled.\n\t\t\t\t\tKeyRotationDuration must be a positive duration value." + }, + { + "name": "AdditionalInfo", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Additional information related to the asymmetric encryption that will be used as\n\t\t\t\t\t\tpart of the key encryption. A device shall support at least 256 characters." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Mode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Mode of encryption.\n\t\t\t\t\tSee tt:EncryptionMode for a list of definitions and capability trc:SupportedEncryptionModes for the supported encryption modes." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional encryption configuration.\n\t\t\t\t\t\tSee capability trc:EncryptionEntryLimit for the number of supported entries.\n\t\t\t\t\t\tBy specifying multiple encryption entries per recording, different tracks can be encrypted with different configurations.\n\t\t\t\t\t\tEach track shall only be contained in one encryption configuration." + }, + { + "name": "SegmentDurationOverride", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Duration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current value of the segment duration." + }, + { + "name": "Expiration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Time remaining until the override expires." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Value of the active OverrideSegmentDuration parameters if one exists. (readonly)" + }, + { + "name": "StorageStrategy", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Strategy to be used on how to store recordings, see tt:StorageStrategy for allowed values. If undefined, defaults to External." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional external storage target configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configuration of the recording." + }, + { + "name": "Tracks", + "type": "{http://www.onvif.org/ver10/schema}GetTracksResponseList", + "type_name": "GetTracksResponseList", + "definition": { + "kind": "complexType", + "name": "GetTracksResponseList", + "fields": [ + { + "name": "Track", + "type": "{http://www.onvif.org/ver10/schema}GetTracksResponseItem", + "type_name": "GetTracksResponseItem", + "definition": { + "kind": "complexType", + "name": "GetTracksResponseItem", + "fields": [ + { + "name": "TrackToken", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the track." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}TrackConfiguration", + "type_name": "TrackConfiguration", + "definition": { + "kind": "complexType", + "name": "TrackConfiguration", + "fields": [ + { + "name": "TrackType", + "type": "{http://www.onvif.org/ver10/schema}TrackType", + "type_name": "TrackType", + "definition": { + "kind": "simpleType", + "name": "TrackType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Video" + }, + { + "value": "Audio" + }, + { + "value": "Metadata" + }, + { + "value": "Extended", + "description": "Placeholder for future extension." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of the track. It shall be equal to the strings \"Video\",\n\t\t\t\t\"Audio\" or \"Metadata\". The track shall only be able to hold data of that type." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the track." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configuration of the track." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Configuration of a track." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of tracks." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of recording items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "SetRecordingConfiguration", + "port_type": "RecordingPort", + "description": "SetRecordingConfiguration shall change the configuration of a recording.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}SetRecordingConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}SetRecordingConfiguration", + "schema": { + "name": "SetRecordingConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the recording that shall be changed." + }, + { + "name": "RecordingConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RecordingConfiguration", + "type_name": "RecordingConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingConfiguration", + "fields": [ + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}RecordingSourceInformation", + "type_name": "RecordingSourceInformation", + "definition": { + "kind": "complexType", + "name": "RecordingSourceInformation", + "description": "A set of informative descriptions of a data source. The Search service allows a client to filter on recordings based on information in this structure.", + "fields": [ + { + "name": "SourceId", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifier for the source chosen by the client that creates the structure.\n\t\t\t\tThis identifier is opaque to the device. Clients may use any type of URI for this field. A device shall support at least 128 characters." + }, + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative user readable name of the source, e.g. \"Camera23\". A device shall support at least 20 characters." + }, + { + "name": "Location", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the physical location of the source, e.g. the coordinates on a map." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the source." + }, + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "URI provided by the service supplying data to be recorded. A device shall support at least 128 characters." + }, + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The video source token of all recordings that will use this configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Information about the source of the recording." + }, + { + "name": "Content", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the source." + }, + { + "name": "MaximumRetentionTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the maximum time that data in any track within the\n\t\t\t\trecording shall be stored. The device shall delete any data older than the maximum retention\n\t\t\t\ttime. Such data shall not be accessible anymore. If the MaximumRetentionPeriod is set to 0,\n\t\t\t\tthe device shall not limit the retention time of stored data, except by resource constraints.\n\t\t\t\tWhatever the value of MaximumRetentionTime, the device may automatically delete\n\t\t\t\trecordings to free up storage space for new recordings. This parameter has no effect on the data stored in external targets for e.g. Object Storage." + }, + { + "name": "Target", + "type": "{http://www.onvif.org/ver10/schema}RecordingTargetConfiguration", + "type_name": "RecordingTargetConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingTargetConfiguration", + "fields": [ + { + "name": "Storage", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of a storage configuration." + }, + { + "name": "Format", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Format of the recording.\n\t\t\t\t\t\tSee tt:TargetFormat for a list of definitions and capability trc:SupportedTargetFormats for the supported formats." + }, + { + "name": "Prefix", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Path prefix to be inserted in the object key. A device shall support at least 128 characters." + }, + { + "name": "Postfix", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Path postfix to be inserted in the object key. A device shall support at least 128 characters." + }, + { + "name": "SpanDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum duration of a span." + }, + { + "name": "SegmentDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum duration of a segment." + }, + { + "name": "Encryption", + "type": "{http://www.onvif.org/ver10/schema}RecordingEncryption", + "type_name": "RecordingEncryption", + "definition": { + "kind": "complexType", + "name": "RecordingEncryption", + "fields": [ + { + "name": "KID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Key ID of the associated key for encryption, formatted as a UUID according to RFC 9562 Section 4. The client shall omit this parameter when AsymmetricEncryption is configured." + }, + { + "name": "Key", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Key for encrypting content. The client shall omit this parameter when AsymmetricEncryption is configured.\n\t\t\t\t\t\tThe device shall not include this parameter when reading." + }, + { + "name": "Track", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional list of track tokens to be encrypted.\n\t\t\t\t\t\tIf no track tokens are specified, all tracks are encrypted and no other encryption configurations shall exist for the recording.\n\t\t\t\t\t\tEach track shall only be contained in one encryption configuration." + }, + { + "name": "AsymmetricEncryption", + "type": "{http://www.onvif.org/ver10/schema}AsymmetricEncryption", + "type_name": "AsymmetricEncryption", + "definition": { + "kind": "complexType", + "name": "AsymmetricEncryption", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of certificates used to encrypt the symmetric key for the PSSH box." + }, + { + "name": "KeyRotationDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Frequency at which the device shall generate a new key to encrypt a new segment.\n\t\t\t\t\tIf not specified, key rotation is disabled.\n\t\t\t\t\tKeyRotationDuration must be a positive duration value." + }, + { + "name": "AdditionalInfo", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Additional information related to the asymmetric encryption that will be used as\n\t\t\t\t\t\tpart of the key encryption. A device shall support at least 256 characters." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Mode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Mode of encryption.\n\t\t\t\t\tSee tt:EncryptionMode for a list of definitions and capability trc:SupportedEncryptionModes for the supported encryption modes." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional encryption configuration.\n\t\t\t\t\t\tSee capability trc:EncryptionEntryLimit for the number of supported entries.\n\t\t\t\t\t\tBy specifying multiple encryption entries per recording, different tracks can be encrypted with different configurations.\n\t\t\t\t\t\tEach track shall only be contained in one encryption configuration." + }, + { + "name": "SegmentDurationOverride", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Duration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current value of the segment duration." + }, + { + "name": "Expiration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Time remaining until the override expires." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Value of the active OverrideSegmentDuration parameters if one exists. (readonly)" + }, + { + "name": "StorageStrategy", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Strategy to be used on how to store recordings, see tt:StorageStrategy for allowed values. If undefined, defaults to External." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional external storage target configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The new configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}SetRecordingConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}SetRecordingConfigurationResponse", + "schema": { + "name": "SetRecordingConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "GetRecordingConfiguration", + "port_type": "RecordingPort", + "description": "GetRecordingConfiguration shall retrieve the recording configuration for a recording.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingConfiguration", + "schema": { + "name": "GetRecordingConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the configuration to be retrieved." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingConfigurationResponse", + "schema": { + "name": "GetRecordingConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RecordingConfiguration", + "type_name": "RecordingConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingConfiguration", + "fields": [ + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}RecordingSourceInformation", + "type_name": "RecordingSourceInformation", + "definition": { + "kind": "complexType", + "name": "RecordingSourceInformation", + "description": "A set of informative descriptions of a data source. The Search service allows a client to filter on recordings based on information in this structure.", + "fields": [ + { + "name": "SourceId", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifier for the source chosen by the client that creates the structure.\n\t\t\t\tThis identifier is opaque to the device. Clients may use any type of URI for this field. A device shall support at least 128 characters." + }, + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative user readable name of the source, e.g. \"Camera23\". A device shall support at least 20 characters." + }, + { + "name": "Location", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the physical location of the source, e.g. the coordinates on a map." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the source." + }, + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "URI provided by the service supplying data to be recorded. A device shall support at least 128 characters." + }, + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The video source token of all recordings that will use this configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Information about the source of the recording." + }, + { + "name": "Content", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the source." + }, + { + "name": "MaximumRetentionTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the maximum time that data in any track within the\n\t\t\t\trecording shall be stored. The device shall delete any data older than the maximum retention\n\t\t\t\ttime. Such data shall not be accessible anymore. If the MaximumRetentionPeriod is set to 0,\n\t\t\t\tthe device shall not limit the retention time of stored data, except by resource constraints.\n\t\t\t\tWhatever the value of MaximumRetentionTime, the device may automatically delete\n\t\t\t\trecordings to free up storage space for new recordings. This parameter has no effect on the data stored in external targets for e.g. Object Storage." + }, + { + "name": "Target", + "type": "{http://www.onvif.org/ver10/schema}RecordingTargetConfiguration", + "type_name": "RecordingTargetConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingTargetConfiguration", + "fields": [ + { + "name": "Storage", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of a storage configuration." + }, + { + "name": "Format", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Format of the recording.\n\t\t\t\t\t\tSee tt:TargetFormat for a list of definitions and capability trc:SupportedTargetFormats for the supported formats." + }, + { + "name": "Prefix", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Path prefix to be inserted in the object key. A device shall support at least 128 characters." + }, + { + "name": "Postfix", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Path postfix to be inserted in the object key. A device shall support at least 128 characters." + }, + { + "name": "SpanDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum duration of a span." + }, + { + "name": "SegmentDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum duration of a segment." + }, + { + "name": "Encryption", + "type": "{http://www.onvif.org/ver10/schema}RecordingEncryption", + "type_name": "RecordingEncryption", + "definition": { + "kind": "complexType", + "name": "RecordingEncryption", + "fields": [ + { + "name": "KID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Key ID of the associated key for encryption, formatted as a UUID according to RFC 9562 Section 4. The client shall omit this parameter when AsymmetricEncryption is configured." + }, + { + "name": "Key", + "type": "{http://www.w3.org/2001/XMLSchema}hexBinary", + "type_name": "hexBinary", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Key for encrypting content. The client shall omit this parameter when AsymmetricEncryption is configured.\n\t\t\t\t\t\tThe device shall not include this parameter when reading." + }, + { + "name": "Track", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional list of track tokens to be encrypted.\n\t\t\t\t\t\tIf no track tokens are specified, all tracks are encrypted and no other encryption configurations shall exist for the recording.\n\t\t\t\t\t\tEach track shall only be contained in one encryption configuration." + }, + { + "name": "AsymmetricEncryption", + "type": "{http://www.onvif.org/ver10/schema}AsymmetricEncryption", + "type_name": "AsymmetricEncryption", + "definition": { + "kind": "complexType", + "name": "AsymmetricEncryption", + "fields": [ + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of certificates used to encrypt the symmetric key for the PSSH box." + }, + { + "name": "KeyRotationDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Frequency at which the device shall generate a new key to encrypt a new segment.\n\t\t\t\t\tIf not specified, key rotation is disabled.\n\t\t\t\t\tKeyRotationDuration must be a positive duration value." + }, + { + "name": "AdditionalInfo", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Additional information related to the asymmetric encryption that will be used as\n\t\t\t\t\t\tpart of the key encryption. A device shall support at least 256 characters." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Mode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Mode of encryption.\n\t\t\t\t\tSee tt:EncryptionMode for a list of definitions and capability trc:SupportedEncryptionModes for the supported encryption modes." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional encryption configuration.\n\t\t\t\t\t\tSee capability trc:EncryptionEntryLimit for the number of supported entries.\n\t\t\t\t\t\tBy specifying multiple encryption entries per recording, different tracks can be encrypted with different configurations.\n\t\t\t\t\t\tEach track shall only be contained in one encryption configuration." + }, + { + "name": "SegmentDurationOverride", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Duration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current value of the segment duration." + }, + { + "name": "Expiration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Time remaining until the override expires." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Value of the active OverrideSegmentDuration parameters if one exists. (readonly)" + }, + { + "name": "StorageStrategy", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Strategy to be used on how to store recordings, see tt:StorageStrategy for allowed values. If undefined, defaults to External." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional external storage target configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configuration of the recording." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "GetRecordingOptions", + "port_type": "RecordingPort", + "description": "GetRecordingOptions returns information for a recording identified by the RecordingToken. The information includes the number of additonal tracks as well as recording jobs that can be configured.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingOptions", + "schema": { + "name": "GetRecordingOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the recording." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingOptionsResponse", + "schema": { + "name": "GetRecordingOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/recording/wsdl}RecordingOptions", + "type_name": "RecordingOptions", + "definition": { + "kind": "complexType", + "name": "RecordingOptions", + "fields": [ + { + "name": "Job", + "type": "{http://www.onvif.org/ver10/recording/wsdl}JobOptions", + "type_name": "JobOptions", + "definition": { + "kind": "complexType", + "name": "JobOptions", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Spare", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Number of spare jobs that can be created for the recording." + }, + { + "use": "optional", + "name": "CompatibleSources", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "A device that supports recording of a restricted set of Media/Media2 Service Profiles returns the list of profiles that can be recorded on the given Recording." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Track", + "type": "{http://www.onvif.org/ver10/recording/wsdl}TrackOptions", + "type_name": "TrackOptions", + "definition": { + "kind": "complexType", + "name": "TrackOptions", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "SpareTotal", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Total spare number of tracks that can be added to this recording." + }, + { + "use": "optional", + "name": "SpareVideo", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Number of spare Video tracks that can be added to this recording." + }, + { + "use": "optional", + "name": "SpareAudio", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Number of spare Aduio tracks that can be added to this recording." + }, + { + "use": "optional", + "name": "SpareMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Number of spare Metadata tracks that can be added to this recording." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configuration of the recording." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "CreateTrack", + "port_type": "RecordingPort", + "description": "This method shall create a new track within a recording. This method is optional. It shall be available if the Recording/DynamicTracks capability is TRUE. A TrackToken in itself does not uniquely identify a specific track. Tracks within different recordings may have the same TrackToken.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}CreateTrackRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}CreateTrack", + "schema": { + "name": "CreateTrack", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifies the recording to which a track shall be added." + }, + { + "name": "TrackConfiguration", + "type": "{http://www.onvif.org/ver10/schema}TrackConfiguration", + "type_name": "TrackConfiguration", + "definition": { + "kind": "complexType", + "name": "TrackConfiguration", + "fields": [ + { + "name": "TrackType", + "type": "{http://www.onvif.org/ver10/schema}TrackType", + "type_name": "TrackType", + "definition": { + "kind": "simpleType", + "name": "TrackType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Video" + }, + { + "value": "Audio" + }, + { + "value": "Metadata" + }, + { + "value": "Extended", + "description": "Placeholder for future extension." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of the track. It shall be equal to the strings \"Video\",\n\t\t\t\t\"Audio\" or \"Metadata\". The track shall only be able to hold data of that type." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the track." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The configuration of the new track." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}CreateTrackResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}CreateTrackResponse", + "schema": { + "name": "CreateTrackResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TrackToken", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The TrackToken shall identify the newly created track. The\n\t\t\t\t\t\t\tTrackToken shall be unique within the recoding to which\n\t\t\t\t\t\t\tthe new track belongs." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "DeleteTrack", + "port_type": "RecordingPort", + "description": "DeleteTrack shall remove a track from a recording. All the data in the track shall be deleted. This method is optional. It shall be available if the Recording/DynamicTracks capability is TRUE.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}DeleteTrackRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}DeleteTrack", + "schema": { + "name": "DeleteTrack", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the recording the track belongs to." + }, + { + "name": "TrackToken", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the track to be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}DeleteTrackResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}DeleteTrackResponse", + "schema": { + "name": "DeleteTrackResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "GetTrackConfiguration", + "port_type": "RecordingPort", + "description": "GetTrackConfiguration shall retrieve the configuration for a specific track.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetTrackConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetTrackConfiguration", + "schema": { + "name": "GetTrackConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the recording the track belongs to." + }, + { + "name": "TrackToken", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the track." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetTrackConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetTrackConfigurationResponse", + "schema": { + "name": "GetTrackConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TrackConfiguration", + "type": "{http://www.onvif.org/ver10/schema}TrackConfiguration", + "type_name": "TrackConfiguration", + "definition": { + "kind": "complexType", + "name": "TrackConfiguration", + "fields": [ + { + "name": "TrackType", + "type": "{http://www.onvif.org/ver10/schema}TrackType", + "type_name": "TrackType", + "definition": { + "kind": "simpleType", + "name": "TrackType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Video" + }, + { + "value": "Audio" + }, + { + "value": "Metadata" + }, + { + "value": "Extended", + "description": "Placeholder for future extension." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of the track. It shall be equal to the strings \"Video\",\n\t\t\t\t\"Audio\" or \"Metadata\". The track shall only be able to hold data of that type." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the track." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configuration of the track." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "SetTrackConfiguration", + "port_type": "RecordingPort", + "description": "SetTrackConfiguration shall change the configuration of a track.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}SetTrackConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}SetTrackConfiguration", + "schema": { + "name": "SetTrackConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the recording the track belongs to." + }, + { + "name": "TrackToken", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the track to be modified." + }, + { + "name": "TrackConfiguration", + "type": "{http://www.onvif.org/ver10/schema}TrackConfiguration", + "type_name": "TrackConfiguration", + "definition": { + "kind": "complexType", + "name": "TrackConfiguration", + "fields": [ + { + "name": "TrackType", + "type": "{http://www.onvif.org/ver10/schema}TrackType", + "type_name": "TrackType", + "definition": { + "kind": "simpleType", + "name": "TrackType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Video" + }, + { + "value": "Audio" + }, + { + "value": "Metadata" + }, + { + "value": "Extended", + "description": "Placeholder for future extension." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of the track. It shall be equal to the strings \"Video\",\n\t\t\t\t\"Audio\" or \"Metadata\". The track shall only be able to hold data of that type." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the track." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "New configuration for the track." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}SetTrackConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}SetTrackConfigurationResponse", + "schema": { + "name": "SetTrackConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "CreateRecordingJob", + "port_type": "RecordingPort", + "description": "CreateRecordingJob shall create a new recording job. The JobConfiguration returned from CreateRecordingJob shall be identical to the JobConfiguration passed into CreateRecordingJob, except for the ReceiverToken and the AutoCreateReceiver. In the returned structure, the ReceiverToken shall be present and valid and the AutoCreateReceiver field shall be omitted.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}CreateRecordingJobRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}CreateRecordingJob", + "schema": { + "name": "CreateRecordingJob", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "JobConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobConfiguration", + "type_name": "RecordingJobConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingJobConfiguration", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifies the recording to which this job shall store the received data." + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobMode", + "type_name": "RecordingJobMode", + "definition": { + "kind": "simpleType", + "name": "RecordingJobMode", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The mode of the job. If it is idle, nothing shall happen. If it is active, the device shall try\n\t\t\t\tto obtain data from the receivers. A client shall use GetRecordingJobState to determine if data transfer is really taking place.
\n\t\t\t\tThe only valid values for Mode shall be \"Idle\" and \"Active\"." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This shall be a non-negative number. If there are multiple recording jobs that store data to\n\t\t\t\tthe same track, the device will only store the data for the recording job with the highest\n\t\t\t\tpriority. The priority is specified per recording job, but the device shall determine the priority\n\t\t\t\tof each track individually. If there are two recording jobs with the same priority, the device\n\t\t\t\tshall record the data corresponding to the recording job that was activated the latest." + }, + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobSource", + "type_name": "RecordingJobSource", + "definition": { + "kind": "complexType", + "name": "RecordingJobSource", + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}SourceReference", + "type_name": "SourceReference", + "definition": { + "kind": "complexType", + "name": "SourceReference", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "default": "http://www.onvif.org/ver10/schema/Receiver" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "This field shall be a reference to the source of the data. The type of the source\n\t\t\t\tis determined by the attribute Type in the SourceToken structure. If Type is\n\t\t\t\thttp://www.onvif.org/ver10/schema/Receiver, the token is a ReceiverReference. In this case\n\t\t\t\tthe device shall receive the data over the network. If Type is\n\t\t\t\thttp://www.onvif.org/ver10/schema/Profile, the token identifies a media profile, provisioned via the ONVIF Media Service or the ONVIF Media2 Service,\n\t\t\t\tinstructing the device to obtain data from a profile that exists on the local device." + }, + { + "name": "AutoCreateReceiver", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If this field is TRUE, and if the SourceToken is omitted, the device\n\t\t\t\tshall create a receiver object (through the receiver service) and assign the\n\t\t\t\tReceiverReference to the SourceToken field. When retrieving the RecordingJobConfiguration\n\t\t\t\tfrom the device, the AutoCreateReceiver field shall never be present." + }, + { + "name": "Tracks", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobTrack", + "type_name": "RecordingJobTrack", + "definition": { + "kind": "complexType", + "name": "RecordingJobTrack", + "fields": [ + { + "name": "SourceTag", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If the received RTSP stream contains multiple tracks of the same type, the\n\t\t\t\t\t\tSourceTag differentiates between those Tracks. This field can be ignored in case of recording a local source." + }, + { + "name": "Destination", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The destination is the tracktoken of the track to which the device shall store the\n\t\t\t\treceived data." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of tracks associated with the recording." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobSourceExtension", + "type_name": "RecordingJobSourceExtension", + "definition": { + "kind": "complexType", + "name": "RecordingJobSourceExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Source of the recording." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobConfigurationExtension", + "type_name": "RecordingJobConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RecordingJobConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "EventFilter", + "type": "{http://www.onvif.org/ver10/schema}RecordingEventFilter", + "type_name": "RecordingEventFilter", + "definition": { + "kind": "complexType", + "name": "RecordingEventFilter", + "fields": [ + { + "name": "Filter", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Topic", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Topic filter as defined in section 9.6.3 of the ONVIF Core Specification." + }, + { + "name": "Source", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional message source content filter as defined in section 9.4.4 of the ONVIF Core Specification." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Before", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional timespan to record before the actual event condition became active." + }, + { + "name": "After", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional timespan to record after the actual event condition becomes inactive." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional filter defining on which event condition a recording job gets active." + } + ], + "attributes": [ + { + "use": "optional", + "name": "ScheduleToken", + "description": "This attribute adds an additional requirement for activating the recording job.\n\t\t\t\tIf this optional field is provided the job shall only record if the schedule exists and is active." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The initial configuration of the new recording job." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}CreateRecordingJobResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}CreateRecordingJobResponse", + "schema": { + "name": "CreateRecordingJobResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "JobToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobReference", + "type_name": "RecordingJobReference", + "definition": { + "kind": "simpleType", + "name": "RecordingJobReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The JobToken shall identify the created recording job." + }, + { + "name": "JobConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobConfiguration", + "type_name": "RecordingJobConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingJobConfiguration", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifies the recording to which this job shall store the received data." + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobMode", + "type_name": "RecordingJobMode", + "definition": { + "kind": "simpleType", + "name": "RecordingJobMode", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The mode of the job. If it is idle, nothing shall happen. If it is active, the device shall try\n\t\t\t\tto obtain data from the receivers. A client shall use GetRecordingJobState to determine if data transfer is really taking place.
\n\t\t\t\tThe only valid values for Mode shall be \"Idle\" and \"Active\"." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This shall be a non-negative number. If there are multiple recording jobs that store data to\n\t\t\t\tthe same track, the device will only store the data for the recording job with the highest\n\t\t\t\tpriority. The priority is specified per recording job, but the device shall determine the priority\n\t\t\t\tof each track individually. If there are two recording jobs with the same priority, the device\n\t\t\t\tshall record the data corresponding to the recording job that was activated the latest." + }, + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobSource", + "type_name": "RecordingJobSource", + "definition": { + "kind": "complexType", + "name": "RecordingJobSource", + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}SourceReference", + "type_name": "SourceReference", + "definition": { + "kind": "complexType", + "name": "SourceReference", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "default": "http://www.onvif.org/ver10/schema/Receiver" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "This field shall be a reference to the source of the data. The type of the source\n\t\t\t\tis determined by the attribute Type in the SourceToken structure. If Type is\n\t\t\t\thttp://www.onvif.org/ver10/schema/Receiver, the token is a ReceiverReference. In this case\n\t\t\t\tthe device shall receive the data over the network. If Type is\n\t\t\t\thttp://www.onvif.org/ver10/schema/Profile, the token identifies a media profile, provisioned via the ONVIF Media Service or the ONVIF Media2 Service,\n\t\t\t\tinstructing the device to obtain data from a profile that exists on the local device." + }, + { + "name": "AutoCreateReceiver", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If this field is TRUE, and if the SourceToken is omitted, the device\n\t\t\t\tshall create a receiver object (through the receiver service) and assign the\n\t\t\t\tReceiverReference to the SourceToken field. When retrieving the RecordingJobConfiguration\n\t\t\t\tfrom the device, the AutoCreateReceiver field shall never be present." + }, + { + "name": "Tracks", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobTrack", + "type_name": "RecordingJobTrack", + "definition": { + "kind": "complexType", + "name": "RecordingJobTrack", + "fields": [ + { + "name": "SourceTag", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If the received RTSP stream contains multiple tracks of the same type, the\n\t\t\t\t\t\tSourceTag differentiates between those Tracks. This field can be ignored in case of recording a local source." + }, + { + "name": "Destination", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The destination is the tracktoken of the track to which the device shall store the\n\t\t\t\treceived data." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of tracks associated with the recording." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobSourceExtension", + "type_name": "RecordingJobSourceExtension", + "definition": { + "kind": "complexType", + "name": "RecordingJobSourceExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Source of the recording." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobConfigurationExtension", + "type_name": "RecordingJobConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RecordingJobConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "EventFilter", + "type": "{http://www.onvif.org/ver10/schema}RecordingEventFilter", + "type_name": "RecordingEventFilter", + "definition": { + "kind": "complexType", + "name": "RecordingEventFilter", + "fields": [ + { + "name": "Filter", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Topic", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Topic filter as defined in section 9.6.3 of the ONVIF Core Specification." + }, + { + "name": "Source", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional message source content filter as defined in section 9.4.4 of the ONVIF Core Specification." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Before", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional timespan to record before the actual event condition became active." + }, + { + "name": "After", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional timespan to record after the actual event condition becomes inactive." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional filter defining on which event condition a recording job gets active." + } + ], + "attributes": [ + { + "use": "optional", + "name": "ScheduleToken", + "description": "This attribute adds an additional requirement for activating the recording job.\n\t\t\t\tIf this optional field is provided the job shall only record if the schedule exists and is active." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The JobConfiguration structure shall be the configuration as it is used by the device. This may be different from the\n\t\t\t\t\t\t\tJobConfiguration passed to CreateRecordingJob." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "DeleteRecordingJob", + "port_type": "RecordingPort", + "description": "DeleteRecordingJob removes a recording job. It shall also implicitly delete all the receiver objects associated with the recording job that are automatically created using the AutoCreateReceiver field of the recording job configuration structure and are not used in any other recording job.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}DeleteRecordingJobRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}DeleteRecordingJob", + "schema": { + "name": "DeleteRecordingJob", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "JobToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobReference", + "type_name": "RecordingJobReference", + "definition": { + "kind": "simpleType", + "name": "RecordingJobReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the job to be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}DeleteRecordingJobResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}DeleteRecordingJobResponse", + "schema": { + "name": "DeleteRecordingJobResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "GetRecordingJobs", + "port_type": "RecordingPort", + "description": "GetRecordingJobs shall return a list of all the recording jobs in the device.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingJobsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingJobs", + "schema": { + "name": "GetRecordingJobs", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingJobsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingJobsResponse", + "schema": { + "name": "GetRecordingJobsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "JobItem", + "type": "{http://www.onvif.org/ver10/schema}GetRecordingJobsResponseItem", + "type_name": "GetRecordingJobsResponseItem", + "definition": { + "kind": "complexType", + "name": "GetRecordingJobsResponseItem", + "fields": [ + { + "name": "JobToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobReference", + "type_name": "RecordingJobReference", + "definition": { + "kind": "simpleType", + "name": "RecordingJobReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "JobConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobConfiguration", + "type_name": "RecordingJobConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingJobConfiguration", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifies the recording to which this job shall store the received data." + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobMode", + "type_name": "RecordingJobMode", + "definition": { + "kind": "simpleType", + "name": "RecordingJobMode", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The mode of the job. If it is idle, nothing shall happen. If it is active, the device shall try\n\t\t\t\tto obtain data from the receivers. A client shall use GetRecordingJobState to determine if data transfer is really taking place.
\n\t\t\t\tThe only valid values for Mode shall be \"Idle\" and \"Active\"." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This shall be a non-negative number. If there are multiple recording jobs that store data to\n\t\t\t\tthe same track, the device will only store the data for the recording job with the highest\n\t\t\t\tpriority. The priority is specified per recording job, but the device shall determine the priority\n\t\t\t\tof each track individually. If there are two recording jobs with the same priority, the device\n\t\t\t\tshall record the data corresponding to the recording job that was activated the latest." + }, + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobSource", + "type_name": "RecordingJobSource", + "definition": { + "kind": "complexType", + "name": "RecordingJobSource", + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}SourceReference", + "type_name": "SourceReference", + "definition": { + "kind": "complexType", + "name": "SourceReference", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "default": "http://www.onvif.org/ver10/schema/Receiver" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "This field shall be a reference to the source of the data. The type of the source\n\t\t\t\tis determined by the attribute Type in the SourceToken structure. If Type is\n\t\t\t\thttp://www.onvif.org/ver10/schema/Receiver, the token is a ReceiverReference. In this case\n\t\t\t\tthe device shall receive the data over the network. If Type is\n\t\t\t\thttp://www.onvif.org/ver10/schema/Profile, the token identifies a media profile, provisioned via the ONVIF Media Service or the ONVIF Media2 Service,\n\t\t\t\tinstructing the device to obtain data from a profile that exists on the local device." + }, + { + "name": "AutoCreateReceiver", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If this field is TRUE, and if the SourceToken is omitted, the device\n\t\t\t\tshall create a receiver object (through the receiver service) and assign the\n\t\t\t\tReceiverReference to the SourceToken field. When retrieving the RecordingJobConfiguration\n\t\t\t\tfrom the device, the AutoCreateReceiver field shall never be present." + }, + { + "name": "Tracks", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobTrack", + "type_name": "RecordingJobTrack", + "definition": { + "kind": "complexType", + "name": "RecordingJobTrack", + "fields": [ + { + "name": "SourceTag", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If the received RTSP stream contains multiple tracks of the same type, the\n\t\t\t\t\t\tSourceTag differentiates between those Tracks. This field can be ignored in case of recording a local source." + }, + { + "name": "Destination", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The destination is the tracktoken of the track to which the device shall store the\n\t\t\t\treceived data." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of tracks associated with the recording." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobSourceExtension", + "type_name": "RecordingJobSourceExtension", + "definition": { + "kind": "complexType", + "name": "RecordingJobSourceExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Source of the recording." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobConfigurationExtension", + "type_name": "RecordingJobConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RecordingJobConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "EventFilter", + "type": "{http://www.onvif.org/ver10/schema}RecordingEventFilter", + "type_name": "RecordingEventFilter", + "definition": { + "kind": "complexType", + "name": "RecordingEventFilter", + "fields": [ + { + "name": "Filter", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Topic", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Topic filter as defined in section 9.6.3 of the ONVIF Core Specification." + }, + { + "name": "Source", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional message source content filter as defined in section 9.4.4 of the ONVIF Core Specification." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Before", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional timespan to record before the actual event condition became active." + }, + { + "name": "After", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional timespan to record after the actual event condition becomes inactive." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional filter defining on which event condition a recording job gets active." + } + ], + "attributes": [ + { + "use": "optional", + "name": "ScheduleToken", + "description": "This attribute adds an additional requirement for activating the recording job.\n\t\t\t\tIf this optional field is provided the job shall only record if the schedule exists and is active." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of recording jobs." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "SetRecordingJobConfiguration", + "port_type": "RecordingPort", + "description": "SetRecordingJobConfiguration shall change the configuration for a recording job. SetRecordingJobConfiguration shall implicitly delete any receiver objects that were created automatically if they are no longer used as a result of changing the recording job configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}SetRecordingJobConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}SetRecordingJobConfiguration", + "schema": { + "name": "SetRecordingJobConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "JobToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobReference", + "type_name": "RecordingJobReference", + "definition": { + "kind": "simpleType", + "name": "RecordingJobReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the job to be modified." + }, + { + "name": "JobConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobConfiguration", + "type_name": "RecordingJobConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingJobConfiguration", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifies the recording to which this job shall store the received data." + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobMode", + "type_name": "RecordingJobMode", + "definition": { + "kind": "simpleType", + "name": "RecordingJobMode", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The mode of the job. If it is idle, nothing shall happen. If it is active, the device shall try\n\t\t\t\tto obtain data from the receivers. A client shall use GetRecordingJobState to determine if data transfer is really taking place.
\n\t\t\t\tThe only valid values for Mode shall be \"Idle\" and \"Active\"." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This shall be a non-negative number. If there are multiple recording jobs that store data to\n\t\t\t\tthe same track, the device will only store the data for the recording job with the highest\n\t\t\t\tpriority. The priority is specified per recording job, but the device shall determine the priority\n\t\t\t\tof each track individually. If there are two recording jobs with the same priority, the device\n\t\t\t\tshall record the data corresponding to the recording job that was activated the latest." + }, + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobSource", + "type_name": "RecordingJobSource", + "definition": { + "kind": "complexType", + "name": "RecordingJobSource", + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}SourceReference", + "type_name": "SourceReference", + "definition": { + "kind": "complexType", + "name": "SourceReference", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "default": "http://www.onvif.org/ver10/schema/Receiver" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "This field shall be a reference to the source of the data. The type of the source\n\t\t\t\tis determined by the attribute Type in the SourceToken structure. If Type is\n\t\t\t\thttp://www.onvif.org/ver10/schema/Receiver, the token is a ReceiverReference. In this case\n\t\t\t\tthe device shall receive the data over the network. If Type is\n\t\t\t\thttp://www.onvif.org/ver10/schema/Profile, the token identifies a media profile, provisioned via the ONVIF Media Service or the ONVIF Media2 Service,\n\t\t\t\tinstructing the device to obtain data from a profile that exists on the local device." + }, + { + "name": "AutoCreateReceiver", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If this field is TRUE, and if the SourceToken is omitted, the device\n\t\t\t\tshall create a receiver object (through the receiver service) and assign the\n\t\t\t\tReceiverReference to the SourceToken field. When retrieving the RecordingJobConfiguration\n\t\t\t\tfrom the device, the AutoCreateReceiver field shall never be present." + }, + { + "name": "Tracks", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobTrack", + "type_name": "RecordingJobTrack", + "definition": { + "kind": "complexType", + "name": "RecordingJobTrack", + "fields": [ + { + "name": "SourceTag", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If the received RTSP stream contains multiple tracks of the same type, the\n\t\t\t\t\t\tSourceTag differentiates between those Tracks. This field can be ignored in case of recording a local source." + }, + { + "name": "Destination", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The destination is the tracktoken of the track to which the device shall store the\n\t\t\t\treceived data." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of tracks associated with the recording." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobSourceExtension", + "type_name": "RecordingJobSourceExtension", + "definition": { + "kind": "complexType", + "name": "RecordingJobSourceExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Source of the recording." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobConfigurationExtension", + "type_name": "RecordingJobConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RecordingJobConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "EventFilter", + "type": "{http://www.onvif.org/ver10/schema}RecordingEventFilter", + "type_name": "RecordingEventFilter", + "definition": { + "kind": "complexType", + "name": "RecordingEventFilter", + "fields": [ + { + "name": "Filter", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Topic", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Topic filter as defined in section 9.6.3 of the ONVIF Core Specification." + }, + { + "name": "Source", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional message source content filter as defined in section 9.4.4 of the ONVIF Core Specification." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Before", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional timespan to record before the actual event condition became active." + }, + { + "name": "After", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional timespan to record after the actual event condition becomes inactive." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional filter defining on which event condition a recording job gets active." + } + ], + "attributes": [ + { + "use": "optional", + "name": "ScheduleToken", + "description": "This attribute adds an additional requirement for activating the recording job.\n\t\t\t\tIf this optional field is provided the job shall only record if the schedule exists and is active." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "New configuration of the recording job." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}SetRecordingJobConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}SetRecordingJobConfigurationResponse", + "schema": { + "name": "SetRecordingJobConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "JobConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobConfiguration", + "type_name": "RecordingJobConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingJobConfiguration", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifies the recording to which this job shall store the received data." + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobMode", + "type_name": "RecordingJobMode", + "definition": { + "kind": "simpleType", + "name": "RecordingJobMode", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The mode of the job. If it is idle, nothing shall happen. If it is active, the device shall try\n\t\t\t\tto obtain data from the receivers. A client shall use GetRecordingJobState to determine if data transfer is really taking place.
\n\t\t\t\tThe only valid values for Mode shall be \"Idle\" and \"Active\"." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This shall be a non-negative number. If there are multiple recording jobs that store data to\n\t\t\t\tthe same track, the device will only store the data for the recording job with the highest\n\t\t\t\tpriority. The priority is specified per recording job, but the device shall determine the priority\n\t\t\t\tof each track individually. If there are two recording jobs with the same priority, the device\n\t\t\t\tshall record the data corresponding to the recording job that was activated the latest." + }, + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobSource", + "type_name": "RecordingJobSource", + "definition": { + "kind": "complexType", + "name": "RecordingJobSource", + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}SourceReference", + "type_name": "SourceReference", + "definition": { + "kind": "complexType", + "name": "SourceReference", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "default": "http://www.onvif.org/ver10/schema/Receiver" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "This field shall be a reference to the source of the data. The type of the source\n\t\t\t\tis determined by the attribute Type in the SourceToken structure. If Type is\n\t\t\t\thttp://www.onvif.org/ver10/schema/Receiver, the token is a ReceiverReference. In this case\n\t\t\t\tthe device shall receive the data over the network. If Type is\n\t\t\t\thttp://www.onvif.org/ver10/schema/Profile, the token identifies a media profile, provisioned via the ONVIF Media Service or the ONVIF Media2 Service,\n\t\t\t\tinstructing the device to obtain data from a profile that exists on the local device." + }, + { + "name": "AutoCreateReceiver", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If this field is TRUE, and if the SourceToken is omitted, the device\n\t\t\t\tshall create a receiver object (through the receiver service) and assign the\n\t\t\t\tReceiverReference to the SourceToken field. When retrieving the RecordingJobConfiguration\n\t\t\t\tfrom the device, the AutoCreateReceiver field shall never be present." + }, + { + "name": "Tracks", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobTrack", + "type_name": "RecordingJobTrack", + "definition": { + "kind": "complexType", + "name": "RecordingJobTrack", + "fields": [ + { + "name": "SourceTag", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If the received RTSP stream contains multiple tracks of the same type, the\n\t\t\t\t\t\tSourceTag differentiates between those Tracks. This field can be ignored in case of recording a local source." + }, + { + "name": "Destination", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The destination is the tracktoken of the track to which the device shall store the\n\t\t\t\treceived data." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of tracks associated with the recording." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobSourceExtension", + "type_name": "RecordingJobSourceExtension", + "definition": { + "kind": "complexType", + "name": "RecordingJobSourceExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Source of the recording." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobConfigurationExtension", + "type_name": "RecordingJobConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RecordingJobConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "EventFilter", + "type": "{http://www.onvif.org/ver10/schema}RecordingEventFilter", + "type_name": "RecordingEventFilter", + "definition": { + "kind": "complexType", + "name": "RecordingEventFilter", + "fields": [ + { + "name": "Filter", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Topic", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Topic filter as defined in section 9.6.3 of the ONVIF Core Specification." + }, + { + "name": "Source", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional message source content filter as defined in section 9.4.4 of the ONVIF Core Specification." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Before", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional timespan to record before the actual event condition became active." + }, + { + "name": "After", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional timespan to record after the actual event condition becomes inactive." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional filter defining on which event condition a recording job gets active." + } + ], + "attributes": [ + { + "use": "optional", + "name": "ScheduleToken", + "description": "This attribute adds an additional requirement for activating the recording job.\n\t\t\t\tIf this optional field is provided the job shall only record if the schedule exists and is active." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The JobConfiguration structure shall be the configuration\n\t\t\t\t\t\t\tas it is used by the device. This may be different from the JobConfiguration passed to SetRecordingJobConfiguration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "GetRecordingJobConfiguration", + "port_type": "RecordingPort", + "description": "GetRecordingJobConfiguration shall return the current configuration for a recording job.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingJobConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingJobConfiguration", + "schema": { + "name": "GetRecordingJobConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "JobToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobReference", + "type_name": "RecordingJobReference", + "definition": { + "kind": "simpleType", + "name": "RecordingJobReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the recording job." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingJobConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingJobConfigurationResponse", + "schema": { + "name": "GetRecordingJobConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "JobConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobConfiguration", + "type_name": "RecordingJobConfiguration", + "definition": { + "kind": "complexType", + "name": "RecordingJobConfiguration", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifies the recording to which this job shall store the received data." + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobMode", + "type_name": "RecordingJobMode", + "definition": { + "kind": "simpleType", + "name": "RecordingJobMode", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The mode of the job. If it is idle, nothing shall happen. If it is active, the device shall try\n\t\t\t\tto obtain data from the receivers. A client shall use GetRecordingJobState to determine if data transfer is really taking place.
\n\t\t\t\tThe only valid values for Mode shall be \"Idle\" and \"Active\"." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This shall be a non-negative number. If there are multiple recording jobs that store data to\n\t\t\t\tthe same track, the device will only store the data for the recording job with the highest\n\t\t\t\tpriority. The priority is specified per recording job, but the device shall determine the priority\n\t\t\t\tof each track individually. If there are two recording jobs with the same priority, the device\n\t\t\t\tshall record the data corresponding to the recording job that was activated the latest." + }, + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobSource", + "type_name": "RecordingJobSource", + "definition": { + "kind": "complexType", + "name": "RecordingJobSource", + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}SourceReference", + "type_name": "SourceReference", + "definition": { + "kind": "complexType", + "name": "SourceReference", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "default": "http://www.onvif.org/ver10/schema/Receiver" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "This field shall be a reference to the source of the data. The type of the source\n\t\t\t\tis determined by the attribute Type in the SourceToken structure. If Type is\n\t\t\t\thttp://www.onvif.org/ver10/schema/Receiver, the token is a ReceiverReference. In this case\n\t\t\t\tthe device shall receive the data over the network. If Type is\n\t\t\t\thttp://www.onvif.org/ver10/schema/Profile, the token identifies a media profile, provisioned via the ONVIF Media Service or the ONVIF Media2 Service,\n\t\t\t\tinstructing the device to obtain data from a profile that exists on the local device." + }, + { + "name": "AutoCreateReceiver", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If this field is TRUE, and if the SourceToken is omitted, the device\n\t\t\t\tshall create a receiver object (through the receiver service) and assign the\n\t\t\t\tReceiverReference to the SourceToken field. When retrieving the RecordingJobConfiguration\n\t\t\t\tfrom the device, the AutoCreateReceiver field shall never be present." + }, + { + "name": "Tracks", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobTrack", + "type_name": "RecordingJobTrack", + "definition": { + "kind": "complexType", + "name": "RecordingJobTrack", + "fields": [ + { + "name": "SourceTag", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If the received RTSP stream contains multiple tracks of the same type, the\n\t\t\t\t\t\tSourceTag differentiates between those Tracks. This field can be ignored in case of recording a local source." + }, + { + "name": "Destination", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The destination is the tracktoken of the track to which the device shall store the\n\t\t\t\treceived data." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of tracks associated with the recording." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobSourceExtension", + "type_name": "RecordingJobSourceExtension", + "definition": { + "kind": "complexType", + "name": "RecordingJobSourceExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Source of the recording." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobConfigurationExtension", + "type_name": "RecordingJobConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RecordingJobConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "EventFilter", + "type": "{http://www.onvif.org/ver10/schema}RecordingEventFilter", + "type_name": "RecordingEventFilter", + "definition": { + "kind": "complexType", + "name": "RecordingEventFilter", + "fields": [ + { + "name": "Filter", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Topic", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Topic filter as defined in section 9.6.3 of the ONVIF Core Specification." + }, + { + "name": "Source", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional message source content filter as defined in section 9.4.4 of the ONVIF Core Specification." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Before", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional timespan to record before the actual event condition became active." + }, + { + "name": "After", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional timespan to record after the actual event condition becomes inactive." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional filter defining on which event condition a recording job gets active." + } + ], + "attributes": [ + { + "use": "optional", + "name": "ScheduleToken", + "description": "This attribute adds an additional requirement for activating the recording job.\n\t\t\t\tIf this optional field is provided the job shall only record if the schedule exists and is active." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current configuration of the recording job." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "SetRecordingJobMode", + "port_type": "RecordingPort", + "description": "SetRecordingJobMode shall change the mode of the recording job. Using this method shall be equivalent to retrieving the recording job configuration, and writing it back with a different mode.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}SetRecordingJobModeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}SetRecordingJobMode", + "schema": { + "name": "SetRecordingJobMode", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "JobToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobReference", + "type_name": "RecordingJobReference", + "definition": { + "kind": "simpleType", + "name": "RecordingJobReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the recording job." + }, + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobMode", + "type_name": "RecordingJobMode", + "definition": { + "kind": "simpleType", + "name": "RecordingJobMode", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The new mode for the recording job." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}SetRecordingJobModeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}SetRecordingJobModeResponse", + "schema": { + "name": "SetRecordingJobModeResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "GetRecordingJobState", + "port_type": "RecordingPort", + "description": "GetRecordingJobState returns the state of a recording job. It includes an aggregated state, and state for each track of the recording job.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingJobStateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingJobState", + "schema": { + "name": "GetRecordingJobState", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "JobToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobReference", + "type_name": "RecordingJobReference", + "definition": { + "kind": "simpleType", + "name": "RecordingJobReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the recording job." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingJobStateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetRecordingJobStateResponse", + "schema": { + "name": "GetRecordingJobStateResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "State", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobStateInformation", + "type_name": "RecordingJobStateInformation", + "definition": { + "kind": "complexType", + "name": "RecordingJobStateInformation", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identification of the recording that the recording job records to." + }, + { + "name": "State", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobState", + "type_name": "RecordingJobState", + "definition": { + "kind": "simpleType", + "name": "RecordingJobState", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Holds the aggregated state over the whole RecordingJobInformation structure." + }, + { + "name": "Sources", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobStateSource", + "type_name": "RecordingJobStateSource", + "definition": { + "kind": "complexType", + "name": "RecordingJobStateSource", + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}SourceReference", + "type_name": "SourceReference", + "definition": { + "kind": "complexType", + "name": "SourceReference", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "default": "http://www.onvif.org/ver10/schema/Receiver" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifies the data source of the recording job." + }, + { + "name": "State", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobState", + "type_name": "RecordingJobState", + "definition": { + "kind": "simpleType", + "name": "RecordingJobState", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Holds the aggregated state over all substructures of RecordingJobStateSource." + }, + { + "name": "Tracks", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobStateTracks", + "type_name": "RecordingJobStateTracks", + "definition": { + "kind": "complexType", + "name": "RecordingJobStateTracks", + "fields": [ + { + "name": "Track", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobStateTrack", + "type_name": "RecordingJobStateTrack", + "definition": { + "kind": "complexType", + "name": "RecordingJobStateTrack", + "fields": [ + { + "name": "SourceTag", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifies the track of the data source that provides the data." + }, + { + "name": "Destination", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the destination track." + }, + { + "name": "Error", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optionally holds an implementation defined string value that describes the error.\n\t\t\t\tThe string should be in the English language." + }, + { + "name": "State", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobState", + "type_name": "RecordingJobState", + "definition": { + "kind": "simpleType", + "name": "RecordingJobState", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Provides the job state of the track. The valid\n\t\t\t\tvalues of state shall be \"Idle\", \"Active\" and \"Error\". If state equals \"Error\", the Error field may be filled in with an implementation defined value." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of track items." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Identifies the data source of the recording job." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RecordingJobStateInformationExtension", + "type_name": "RecordingJobStateInformationExtension", + "definition": { + "kind": "complexType", + "name": "RecordingJobStateInformationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The current state of the recording job." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "ListRecordedSegments", + "port_type": "RecordingPort", + "description": "Lists available recorded segments related to the specified RecordingToken.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}ListRecordedSegments", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}ListRecordedSegments", + "schema": { + "name": "ListRecordedSegments", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Time", + "type": "{http://www.onvif.org/ver10/schema}DateTimeRange", + "type_name": "DateTimeRange", + "definition": { + "kind": "complexType", + "name": "DateTimeRange", + "fields": [ + { + "name": "From", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Until", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The start to end time of the query." + }, + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The recording configuration token." + }, + { + "name": "MaxResults", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The maximum number of results to return in one response." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Gets segments available within a time range." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}ListRecordedSegmentsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}ListRecordedSegmentsResponse", + "schema": { + "name": "ListRecordedSegmentsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Results", + "type": "{http://www.onvif.org/ver10/recording/wsdl}SegmentListResult", + "type_name": "SegmentListResult", + "definition": { + "kind": "complexType", + "name": "SegmentListResult", + "fields": [ + { + "name": "Segment", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StartTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Same precision as defined in the Recording Control specification for segment objects." + }, + { + "name": "EndTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Same precision as defined in the Recording Control specification for segment objects." + }, + { + "name": "MediaType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "As defined in RFC 6381 including section 3 Codecs." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Information about an exportable segment." + }, + { + "name": "HasMoreResults", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A value indicating that the search has reached the maximum count and a new request must be sent to continue the search." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "ExportRecordedSegments", + "port_type": "RecordingPort", + "description": "Exports the selected recorded segments (from existing recorded data) to the storage attached to the given recording configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}ExportRecordedSegments", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}ExportRecordedSegments", + "schema": { + "name": "ExportRecordedSegments", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Time", + "type": "{http://www.onvif.org/ver10/schema}DateTimeRange", + "type_name": "DateTimeRange", + "definition": { + "kind": "complexType", + "name": "DateTimeRange", + "fields": [ + { + "name": "From", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Until", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The start to end time of the query." + }, + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The recording configuration token." + }, + { + "name": "Alias", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An optional alias that shall be included in the Monitoring/AsynchronousOperationStatus events." + }, + { + "name": "StorageToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If provided, overrides the Target's storage configuration." + }, + { + "name": "Track", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An optional track filter for segments to export when in CMAF. For valid definitions see tt:TrackType." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}ExportRecordedSegmentsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}ExportRecordedSegmentsResponse", + "schema": { + "name": "ExportRecordedSegmentsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OperationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique operation token for client to query the status of the export." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "StopExportRecordedSegments", + "port_type": "RecordingPort", + "description": "Stops the selected ExportRecordedSegments operation.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}StopExportRecordedSegments", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}StopExportRecordedSegments", + "schema": { + "name": "StopExportRecordedSegments", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OperationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique ExportRecordedSegments operation token" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}StopExportRecordedSegmentsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}StopExportRecordedSegmentsResponse", + "schema": { + "name": "StopExportRecordedSegmentsResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "ExportRecordedData", + "port_type": "RecordingPort", + "description": "Exports the selected recordings (from existing recorded data) to the given storage target based on the requested file format.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}ExportRecordedDataRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}ExportRecordedData", + "schema": { + "name": "ExportRecordedData", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StartPoint", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter that specifies start time for the exporting." + }, + { + "name": "EndPoint", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter that specifies end time for the exporting." + }, + { + "name": "SearchScope", + "type": "{http://www.onvif.org/ver10/schema}SearchScope", + "type_name": "SearchScope", + "definition": { + "kind": "complexType", + "name": "SearchScope", + "description": "A structure for defining a limited scope when searching in recorded data.", + "fields": [ + { + "name": "IncludedSources", + "type": "{http://www.onvif.org/ver10/schema}SourceReference", + "type_name": "SourceReference", + "definition": { + "kind": "complexType", + "name": "SourceReference", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "default": "http://www.onvif.org/ver10/schema/Receiver" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of sources that are included in the scope. If this list is included, only data from one of these sources shall be searched." + }, + { + "name": "IncludedRecordings", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of recordings that are included in the scope. If this list is included, only data from one of these recordings shall be searched." + }, + { + "name": "RecordingInformationFilter", + "type": "{http://www.onvif.org/ver10/schema}XPathExpression", + "type_name": "XPathExpression", + "definition": { + "kind": "simpleType", + "name": "XPathExpression", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An xpath expression used to specify what recordings to search. Only those recordings with an RecordingInformation structure that matches the filter shall be searched." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SearchScopeExtension", + "type_name": "SearchScopeExtension", + "definition": { + "kind": "complexType", + "name": "SearchScopeExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Extension point" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the selection criterion on the existing recordings. ." + }, + { + "name": "FileFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates which export file format to be used." + }, + { + "name": "StorageDestination", + "type": "{http://www.onvif.org/ver10/schema}StorageReferencePath", + "type_name": "StorageReferencePath", + "definition": { + "kind": "complexType", + "name": "StorageReferencePath", + "fields": [ + { + "name": "StorageToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "identifier of an existing Storage Configuration." + }, + { + "name": "RelativePath", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "gives the relative directory path on the storage" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}StorageReferencePathExtension", + "type_name": "StorageReferencePathExtension", + "definition": { + "kind": "complexType", + "name": "StorageReferencePathExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the target storage and relative directory path." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}ExportRecordedDataResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}ExportRecordedDataResponse", + "schema": { + "name": "ExportRecordedDataResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OperationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique operation token for client to associate the relevant events." + }, + { + "name": "FileNames", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of exported file names. The device can also use AsyncronousOperationStatus event to publish this list." + }, + { + "name": "Extension", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "StopExportRecordedData", + "port_type": "RecordingPort", + "description": "Stops the selected ExportRecordedData operation.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}StopExportRecordedDataRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}StopExportRecordedData", + "schema": { + "name": "StopExportRecordedData", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OperationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique ExportRecordedData operation token" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}StopExportRecordedDataResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}StopExportRecordedDataResponse", + "schema": { + "name": "StopExportRecordedDataResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Progress", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Progress percentage of ExportRecordedData operation." + }, + { + "name": "FileProgressStatus", + "type": "{http://www.onvif.org/ver10/schema}ArrayOfFileProgress", + "type_name": "ArrayOfFileProgress", + "definition": { + "kind": "complexType", + "name": "ArrayOfFileProgress", + "fields": [ + { + "name": "FileProgress", + "type": "{http://www.onvif.org/ver10/schema}FileProgress", + "type_name": "FileProgress", + "definition": { + "kind": "complexType", + "name": "FileProgress", + "fields": [ + { + "name": "FileName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Exported file name" + }, + { + "name": "Progress", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Normalized percentage completion for uploading the exported file" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Exported file name and export progress information" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ArrayOfFileProgressExtension", + "type_name": "ArrayOfFileProgressExtension", + "definition": { + "kind": "complexType", + "name": "ArrayOfFileProgressExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "GetExportRecordedDataState", + "port_type": "RecordingPort", + "description": "Retrieves the status of selected ExportRecordedData operation.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetExportRecordedDataStateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetExportRecordedDataState", + "schema": { + "name": "GetExportRecordedDataState", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OperationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique ExportRecordedData operation token" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}GetExportRecordedDataStateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}GetExportRecordedDataStateResponse", + "schema": { + "name": "GetExportRecordedDataStateResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Progress", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Progress percentage of ExportRecordedData operation." + }, + { + "name": "FileProgressStatus", + "type": "{http://www.onvif.org/ver10/schema}ArrayOfFileProgress", + "type_name": "ArrayOfFileProgress", + "definition": { + "kind": "complexType", + "name": "ArrayOfFileProgress", + "fields": [ + { + "name": "FileProgress", + "type": "{http://www.onvif.org/ver10/schema}FileProgress", + "type_name": "FileProgress", + "definition": { + "kind": "complexType", + "name": "FileProgress", + "fields": [ + { + "name": "FileName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Exported file name" + }, + { + "name": "Progress", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Normalized percentage completion for uploading the exported file" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Exported file name and export progress information" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ArrayOfFileProgressExtension", + "type_name": "ArrayOfFileProgressExtension", + "definition": { + "kind": "complexType", + "name": "ArrayOfFileProgressExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + }, + { + "name": "OverrideSegmentDuration", + "port_type": "RecordingPort", + "description": "Requests a temporary override of the target segment duration for a recording configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}OverrideSegmentDurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}OverrideSegmentDuration", + "schema": { + "name": "OverrideSegmentDuration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "TargetSegmentDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The new target duration for recorded segments." + }, + { + "name": "Expiration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The length of time during which the override request is to be in effect." + }, + { + "name": "RecordingConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The recording configuration for which the override is requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/recording/wsdl}OverrideSegmentDurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/recording/wsdl}OverrideSegmentDurationResponse", + "schema": { + "name": "OverrideSegmentDurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RecordingBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/replay.json b/docs/generated/wsdl/ver10/replay.json new file mode 100644 index 00000000..3af8acb6 --- /dev/null +++ b/docs/generated/wsdl/ver10/replay.json @@ -0,0 +1,454 @@ +{ + "source": "ver10/replay.wsdl", + "target_namespace": "http://www.onvif.org/ver10/replay/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "ReplayPort", + "description": "Returns the capabilities of the replay service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/replay/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/replay/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/replay/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/replay/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/replay/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "ReversePlayback", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicator that the Device supports reverse playback as defined in the ONVIF Streaming Specification." + }, + { + "use": "optional", + "name": "SessionTimeoutRange", + "type": "{http://www.onvif.org/ver10/schema}FloatList", + "definition": { + "kind": "simpleType", + "name": "FloatList", + "item_type": "{http://www.w3.org/2001/XMLSchema}float" + }, + "description": "The list contains two elements defining the minimum and maximum valid values supported as session timeout in seconds." + }, + { + "use": "optional", + "name": "RTP_RTSP_TCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for RTP/RTSP/TCP." + }, + { + "use": "optional", + "name": "RTSPWebSocketUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "If playback streaming over WebSocket is supported, this shall return the RTSP WebSocket URI as described in Streaming Specification Section 5.1.1.5." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the replay service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ReplayBinding" + }, + { + "name": "GetReplayUri", + "port_type": "ReplayPort", + "description": "Requests a URI that can be used to initiate playback of a recorded stream using RTSP as the control protocol. The URI is valid only as it is specified in the response. A device supporting the Replay Service shall support the GetReplayUri command.", + "input": { + "message": "{http://www.onvif.org/ver10/replay/wsdl}GetReplayUriRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/replay/wsdl}GetReplayUri", + "schema": { + "name": "GetReplayUri", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StreamSetup", + "type": "{http://www.onvif.org/ver10/schema}StreamSetup", + "type_name": "StreamSetup", + "definition": { + "kind": "complexType", + "name": "StreamSetup", + "fields": [ + { + "name": "Stream", + "type": "{http://www.onvif.org/ver10/schema}StreamType", + "type_name": "StreamType", + "definition": { + "kind": "simpleType", + "name": "StreamType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "RTP-Unicast" + }, + { + "value": "RTP-Multicast" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines if a multicast or unicast stream is requested." + }, + { + "name": "Transport", + "type": "{http://www.onvif.org/ver10/schema}Transport", + "type_name": "Transport", + "definition": { + "kind": "complexType", + "name": "Transport", + "fields": [ + { + "name": "Protocol", + "type": "{http://www.onvif.org/ver10/schema}TransportProtocol", + "type_name": "TransportProtocol", + "definition": { + "kind": "simpleType", + "name": "TransportProtocol", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "UDP" + }, + { + "value": "TCP", + "description": "This value is deprecated." + }, + { + "value": "RTSP" + }, + { + "value": "HTTP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP." + }, + { + "name": "Tunnel", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Deprecated: optional element to describe further tunnel options." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the connection parameters to be used for the stream. The URI that is returned may depend on these parameters." + }, + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The identifier of the recording to be streamed." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/replay/wsdl}GetReplayUriResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/replay/wsdl}GetReplayUriResponse", + "schema": { + "name": "GetReplayUriResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The URI to which the client should connect in order to stream the recording." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ReplayBinding" + }, + { + "name": "GetReplayConfiguration", + "port_type": "ReplayPort", + "description": "Returns the current configuration of the replay service. This operation is mandatory.", + "input": { + "message": "{http://www.onvif.org/ver10/replay/wsdl}GetReplayConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/replay/wsdl}GetReplayConfiguration", + "schema": { + "name": "GetReplayConfiguration", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/replay/wsdl}GetReplayConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/replay/wsdl}GetReplayConfigurationResponse", + "schema": { + "name": "GetReplayConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}ReplayConfiguration", + "type_name": "ReplayConfiguration", + "definition": { + "kind": "complexType", + "name": "ReplayConfiguration", + "description": "Configuration parameters for the replay service.", + "fields": [ + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTSP session timeout." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The current replay configuration parameters." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ReplayBinding" + }, + { + "name": "SetReplayConfiguration", + "port_type": "ReplayPort", + "description": "Changes the current configuration of the replay service. This operation is mandatory.", + "input": { + "message": "{http://www.onvif.org/ver10/replay/wsdl}SetReplayConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/replay/wsdl}SetReplayConfiguration", + "schema": { + "name": "SetReplayConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}ReplayConfiguration", + "type_name": "ReplayConfiguration", + "definition": { + "kind": "complexType", + "name": "ReplayConfiguration", + "description": "Configuration parameters for the replay service.", + "fields": [ + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTSP session timeout." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Description of the new replay configuration parameters." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/replay/wsdl}SetReplayConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/replay/wsdl}SetReplayConfigurationResponse", + "schema": { + "name": "SetReplayConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ReplayBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/schedule/wsdl/schedule.json b/docs/generated/wsdl/ver10/schedule/wsdl/schedule.json new file mode 100644 index 00000000..8ec48dea --- /dev/null +++ b/docs/generated/wsdl/ver10/schedule/wsdl/schedule.json @@ -0,0 +1,3280 @@ +{ + "source": "ver10/schedule/wsdl/schedule.wsdl", + "target_namespace": "http://www.onvif.org/ver10/schedule/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "SchedulePort", + "description": "This operation returns the capabilities of the schedule service.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}ServiceCapabilities", + "type_name": "ServiceCapabilities", + "definition": { + "kind": "complexType", + "name": "ServiceCapabilities", + "description": "The service capabilities reflect optional functionality of a service.\n\t\t\t\t\t\tThe information is static and does not change during device operation.\n\t\t\t\t\t\tThe following capabilities are available:", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "MaxLimit", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "The maximum number of entries returned by a single Get<Entity>List or\n\t\t\t\t\t\t\tGet<Entity> request. The device shall never return more than this number\n\t\t\t\t\t\t\tof entities in a single response." + }, + { + "use": "required", + "name": "MaxSchedules", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "Indicates the maximum number of schedules the device supports.\n\t\t\t\t\t\t\tThe device shall support at least one schedule." + }, + { + "use": "required", + "name": "MaxTimePeriodsPerDay", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "Indicates the maximum number of time periods per day the device supports\n\t\t\t\t\t\t\tin a schedule including special days schedule. The device shall support\n\t\t\t\t\t\t\tat least one time period per day." + }, + { + "use": "required", + "name": "MaxSpecialDayGroups", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "Indicates the maximum number of special day group entities the device supports.\n\t\t\t\t\t\t\tThe device shall support at least one ‘SpecialDayGroup’ entity." + }, + { + "use": "required", + "name": "MaxDaysInSpecialDayGroup", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "Indicates the maximum number of days per ‘SpecialDayGroup’ entity the device\n\t\t\t\t\t\t\tsupports. The device shall support at least one day per ‘SpecialDayGroup’ entity." + }, + { + "use": "required", + "name": "MaxSpecialDaysSchedules", + "type": "{http://www.onvif.org/ver10/pacs}PositiveInteger", + "definition": { + "kind": "simpleType", + "name": "PositiveInteger", + "description": "Type used to represent the numbers from 1 ,2 , 3,...", + "base": "{http://www.w3.org/2001/XMLSchema}unsignedInt", + "minInclusive": "1" + }, + "description": "Indicates the maximum number of ‘SpecialDaysSchedule’ entities referred by a\n\t\t\t\t\t\t\tschedule that the device supports." + }, + { + "use": "required", + "name": "ExtendedRecurrenceSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "For schedules:\n\t\t\t\t\t\t\tIf this capability is supported, then all iCalendar recurrence types shall\n\t\t\t\t\t\t\tbe supported by the device. The device shall also support the start and end dates (or\n\t\t\t\t\t\t\tiCalendar occurrence count) in recurring events (see iCalendar examples in section 3).\n\t\t\t\t\t\t\tIf this capability is not supported, then only the weekly iCalendar recurrence\n\t\t\t\t\t\t\ttype shall be supported. Non-recurring events and other recurring types are\n\t\t\t\t\t\t\tnot supported. The device shall only accept a start date with the year ‘1970’\n\t\t\t\t\t\t\t(the month and day is needed to reflect the week day of the recurrence)\n\t\t\t\t\t\t\tand will not accept an occurrence count (or iCalendar until date) in recurring events.\n\t\t\t\t\t\t\tFor special days (only applicable if SpecialDaysSupported is set to true):\n\t\t\t\t\t\t\tIf this capability is supported, then all iCalendar recurrence types shall\n\t\t\t\t\t\t\tbe supported by the device. The device shall also support the start and\n\t\t\t\t\t\t\tend dates (or occurrence count) in recurring events.\n\t\t\t\t\t\t\tIf this capability is not supported, then only non-recurring special days are supported." + }, + { + "use": "required", + "name": "SpecialDaysSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "If this capability is supported, then the device shall support special days." + }, + { + "use": "required", + "name": "StateReportingSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "If this capability is set to true, the device shall implement the\n\t\t\t\t\t\t\tGetScheduleState command, and shall notify subscribing clients whenever\n\t\t\t\t\t\t\tschedules become active or inactive." + }, + { + "use": "optional", + "name": "ClientSuppliedTokenSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "default": "false", + "description": "Indicates that the client is allowed to supply the token when creating schedules and special day groups.\n\t\t\t\t\t\t\tTo enable the use of the commands SetSchedule and SetSpecialDayGroup, the value must be set to true." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capability response message contains the requested schedule service\n\t\t\t\t\t\t\t\t\tcapabilities using a hierarchical XML capability structure." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "GetScheduleState", + "port_type": "SchedulePort", + "description": "This operation requests the ScheduleState for the schedule instance specified by the given token.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleStateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleState", + "schema": { + "name": "GetScheduleState", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of schedule instance to get ScheduleState." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleStateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleStateResponse", + "schema": { + "name": "GetScheduleStateResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ScheduleState", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleState", + "type_name": "ScheduleState", + "definition": { + "kind": "complexType", + "name": "ScheduleState", + "description": "The ScheduleState contains state information for a schedule.", + "fields": [ + { + "name": "Active", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates that the current time is within the boundaries of the schedule\n\t\t\t\t\t\t\t\tor its special days schedules’ time periods. For example, if this\n\t\t\t\t\t\t\t\tschedule is being used for triggering automatic recording on a video source,\n\t\t\t\t\t\t\t\tthe Active flag will be true when the schedule-based recording is supposed to record." + }, + { + "name": "SpecialDay", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates that the current time is within the boundaries of its special\n\t\t\t\t\t\t\t\tdays schedules’ time periods. For example, if this schedule is being used\n\t\t\t\t\t\t\t\tfor recording at a lower frame rate on a video source during special days,\n\t\t\t\t\t\t\t\tthe SpecialDay flag will be true. If special days are not supported by the device,\n\t\t\t\t\t\t\t\tthis field may be omitted and interpreted as false by the client." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleStateExtension", + "type_name": "ScheduleStateExtension", + "definition": { + "kind": "complexType", + "name": "ScheduleStateExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "ScheduleState item." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "GetScheduleInfo", + "port_type": "SchedulePort", + "description": "This method returns a list of schedule info items, specified in the request. Only found schedules shall be returned, i.e., the returned numbers of elements can differ from the requested element. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleInfoRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleInfo", + "schema": { + "name": "GetScheduleInfo", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of ScheduleInfo items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleInfoResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleInfoResponse", + "schema": { + "name": "GetScheduleInfoResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ScheduleInfo", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleInfo", + "type_name": "ScheduleInfo", + "definition": { + "kind": "complexType", + "name": "ScheduleInfo", + "description": "The ScheduleInfo type represents the schedule as a physical object.\n\t\t\t\t\t\tThe structure contains information of a specific schedule instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the schedule. It shall be up to 1024 characters." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of ScheduleInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "GetScheduleInfoList", + "port_type": "SchedulePort", + "description": "This operation requests a list of all of ScheduleInfo items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer Access Control Service Specification for more details. The number of items returned shall not be greater the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleInfoListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleInfoList", + "schema": { + "name": "GetScheduleInfoList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than one\n\t\t\t\t\t\t\t\t\tor higher than what the device supports, the number of items is\n\t\t\t\t\t\t\t\t\tdetermined by the device." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference.\n\t\t\t\t\t\t\t\t\tIf not specified, entries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleInfoListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleInfoListResponse", + "schema": { + "name": "GetScheduleInfoListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items.\n\t\t\t\t\t\t\t\t\tIf absent, no more items to get." + }, + { + "name": "ScheduleInfo", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleInfo", + "type_name": "ScheduleInfo", + "definition": { + "kind": "complexType", + "name": "ScheduleInfo", + "description": "The ScheduleInfo type represents the schedule as a physical object.\n\t\t\t\t\t\tThe structure contains information of a specific schedule instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the schedule. It shall be up to 1024 characters." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of ScheduleInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "GetSchedules", + "port_type": "SchedulePort", + "description": "This operation returns the specified schedule item matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetSchedulesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetSchedules", + "schema": { + "name": "GetSchedules", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of Schedule items to get" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetSchedulesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetSchedulesResponse", + "schema": { + "name": "GetSchedulesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Schedule", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}Schedule", + "type_name": "Schedule", + "definition": { + "kind": "complexType", + "name": "Schedule", + "description": "The schedule structure shall include all properties of the ScheduleInfo structure\n\t\t\t\t\t\tand also the standard events (iCalendar format) and a list of SpecialDaysSchedule instances.", + "base": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleInfo", + "base_definition": { + "kind": "complexType", + "name": "ScheduleInfo", + "description": "The ScheduleInfo type represents the schedule as a physical object.\n\t\t\t\t\t\tThe structure contains information of a specific schedule instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the schedule. It shall be up to 1024 characters." + } + ] + }, + "fields": [ + { + "name": "Standard", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "An iCalendar structure that defines a number of events. Events\n\t\t\t\t\t\t\t\t\t\tcan be recurring or non-recurring. The events can, for instance,\n\t\t\t\t\t\t\t\t\t\tbe used to control when a camera should record or when a facility\n\t\t\t\t\t\t\t\t\t\tis accessible. Some devices might not be able to fully support\n\t\t\t\t\t\t\t\t\t\tall the features of iCalendar. Setting the service capability\n\t\t\t\t\t\t\t\t\t\tExtendedRecurrenceSupported to false will enable more devices\n\t\t\t\t\t\t\t\t\t\tto be ONVIF compliant. Is of type string (but contains an iCalendar structure)." + }, + { + "name": "SpecialDays", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDaysSchedule", + "type_name": "SpecialDaysSchedule", + "definition": { + "kind": "complexType", + "name": "SpecialDaysSchedule", + "description": "A override schedule that defines alternate time periods for a group of special days.", + "fields": [ + { + "name": "GroupToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the list of special days in a schedule." + }, + { + "name": "TimeRange", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}TimePeriod", + "type_name": "TimePeriod", + "definition": { + "kind": "complexType", + "name": "TimePeriod", + "description": "A time period defines a start and end time. For full day access, the\n\t\t\t\t\t\tstart time =\"00:00:00\" with no defined end time. For a time period with no\n\t\t\t\t\t\tend time, the schedule runs until midnight. The end time must always be greater\n\t\t\t\t\t\tthan the start time, otherwise an InvalidArgVal error messages is generated by the device.", + "fields": [ + { + "name": "From", + "type": "{http://www.w3.org/2001/XMLSchema}time", + "type_name": "time", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the start time." + }, + { + "name": "Until", + "type": "{http://www.w3.org/2001/XMLSchema}time", + "type_name": "time", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the end time. Is optional, if omitted, the period ends at midnight.\n\t\t\t\t\t\t\t\tThe end time is exclusive, meaning that that exact moment in time is not\n\t\t\t\t\t\t\t\tpart of the period. To determine if a moment in time (t) is part of a time period,\n\t\t\t\t\t\t\t\tthe formula StartTime ≤ t < EndTime is used." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}TimePeriodExtension", + "type_name": "TimePeriodExtension", + "definition": { + "kind": "complexType", + "name": "TimePeriodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Indicates the alternate time periods for the list of special days\n\t\t\t\t\t\t\t\t(overrides the regular schedule). For example, the regular schedule indicates\n\t\t\t\t\t\t\t\tthat it is active from 8AM to 5PM on Mondays. However, this particular\n\t\t\t\t\t\t\t\tMonday is a special day, and the alternate time periods state that the\n\t\t\t\t\t\t\t\tschedule is active from 9 AM to 11 AM and 1 PM to 4 PM.\n\t\t\t\t\t\t\t\tIf no time periods are defined, then no access is allowed.\n\t\t\t\t\t\t\t\tIs of type TimePeriod." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDaysScheduleExtension", + "type_name": "SpecialDaysScheduleExtension", + "definition": { + "kind": "complexType", + "name": "SpecialDaysScheduleExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "For devices that are not able to support all the features of iCalendar,\n\t\t\t\t\t\t\t\t\t\tsupporting special days is essential. Each SpecialDaysSchedule\n\t\t\t\t\t\t\t\t\t\tinstance defines an alternate set of time periods that overrides\n\t\t\t\t\t\t\t\t\t\tthe regular schedule for a specified list of special days.\n\t\t\t\t\t\t\t\t\t\tIs of type SpecialDaysSchedule." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleExtension", + "type_name": "ScheduleExtension", + "definition": { + "kind": "complexType", + "name": "ScheduleExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of schedule items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "GetScheduleList", + "port_type": "SchedulePort", + "description": "This operation requests a list of all of Schedule items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer Access Control Service Specification for more details. The number of items returned shall not be greater the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleList", + "schema": { + "name": "GetScheduleList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return.\n\t\t\t\t\t\t\t\t\tIf not specified, less than one or higher than what the device supports,\n\t\t\t\t\t\t\t\t\tthe number of items is determined by the device." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference.\n\t\t\t\t\t\t\t\t\tIf not specified, entries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetScheduleListResponse", + "schema": { + "name": "GetScheduleListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items.\n\t\t\t\t\t\t\t\t\tIf absent, no more items to get." + }, + { + "name": "Schedule", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}Schedule", + "type_name": "Schedule", + "definition": { + "kind": "complexType", + "name": "Schedule", + "description": "The schedule structure shall include all properties of the ScheduleInfo structure\n\t\t\t\t\t\tand also the standard events (iCalendar format) and a list of SpecialDaysSchedule instances.", + "base": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleInfo", + "base_definition": { + "kind": "complexType", + "name": "ScheduleInfo", + "description": "The ScheduleInfo type represents the schedule as a physical object.\n\t\t\t\t\t\tThe structure contains information of a specific schedule instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the schedule. It shall be up to 1024 characters." + } + ] + }, + "fields": [ + { + "name": "Standard", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "An iCalendar structure that defines a number of events. Events\n\t\t\t\t\t\t\t\t\t\tcan be recurring or non-recurring. The events can, for instance,\n\t\t\t\t\t\t\t\t\t\tbe used to control when a camera should record or when a facility\n\t\t\t\t\t\t\t\t\t\tis accessible. Some devices might not be able to fully support\n\t\t\t\t\t\t\t\t\t\tall the features of iCalendar. Setting the service capability\n\t\t\t\t\t\t\t\t\t\tExtendedRecurrenceSupported to false will enable more devices\n\t\t\t\t\t\t\t\t\t\tto be ONVIF compliant. Is of type string (but contains an iCalendar structure)." + }, + { + "name": "SpecialDays", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDaysSchedule", + "type_name": "SpecialDaysSchedule", + "definition": { + "kind": "complexType", + "name": "SpecialDaysSchedule", + "description": "A override schedule that defines alternate time periods for a group of special days.", + "fields": [ + { + "name": "GroupToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the list of special days in a schedule." + }, + { + "name": "TimeRange", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}TimePeriod", + "type_name": "TimePeriod", + "definition": { + "kind": "complexType", + "name": "TimePeriod", + "description": "A time period defines a start and end time. For full day access, the\n\t\t\t\t\t\tstart time =\"00:00:00\" with no defined end time. For a time period with no\n\t\t\t\t\t\tend time, the schedule runs until midnight. The end time must always be greater\n\t\t\t\t\t\tthan the start time, otherwise an InvalidArgVal error messages is generated by the device.", + "fields": [ + { + "name": "From", + "type": "{http://www.w3.org/2001/XMLSchema}time", + "type_name": "time", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the start time." + }, + { + "name": "Until", + "type": "{http://www.w3.org/2001/XMLSchema}time", + "type_name": "time", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the end time. Is optional, if omitted, the period ends at midnight.\n\t\t\t\t\t\t\t\tThe end time is exclusive, meaning that that exact moment in time is not\n\t\t\t\t\t\t\t\tpart of the period. To determine if a moment in time (t) is part of a time period,\n\t\t\t\t\t\t\t\tthe formula StartTime ≤ t < EndTime is used." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}TimePeriodExtension", + "type_name": "TimePeriodExtension", + "definition": { + "kind": "complexType", + "name": "TimePeriodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Indicates the alternate time periods for the list of special days\n\t\t\t\t\t\t\t\t(overrides the regular schedule). For example, the regular schedule indicates\n\t\t\t\t\t\t\t\tthat it is active from 8AM to 5PM on Mondays. However, this particular\n\t\t\t\t\t\t\t\tMonday is a special day, and the alternate time periods state that the\n\t\t\t\t\t\t\t\tschedule is active from 9 AM to 11 AM and 1 PM to 4 PM.\n\t\t\t\t\t\t\t\tIf no time periods are defined, then no access is allowed.\n\t\t\t\t\t\t\t\tIs of type TimePeriod." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDaysScheduleExtension", + "type_name": "SpecialDaysScheduleExtension", + "definition": { + "kind": "complexType", + "name": "SpecialDaysScheduleExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "For devices that are not able to support all the features of iCalendar,\n\t\t\t\t\t\t\t\t\t\tsupporting special days is essential. Each SpecialDaysSchedule\n\t\t\t\t\t\t\t\t\t\tinstance defines an alternate set of time periods that overrides\n\t\t\t\t\t\t\t\t\t\tthe regular schedule for a specified list of special days.\n\t\t\t\t\t\t\t\t\t\tIs of type SpecialDaysSchedule." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleExtension", + "type_name": "ScheduleExtension", + "definition": { + "kind": "complexType", + "name": "ScheduleExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of Schedule items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "CreateSchedule", + "port_type": "SchedulePort", + "description": "This operation creates the specified schedule. The token field of the schedule structure shall be empty, the device shall allocate a token for the schedule. The allocated token shall be returned in the response. If the client sends any value in the token field, the device shall return InvalidArgVal as generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}CreateScheduleRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}CreateSchedule", + "schema": { + "name": "CreateSchedule", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Schedule", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}Schedule", + "type_name": "Schedule", + "definition": { + "kind": "complexType", + "name": "Schedule", + "description": "The schedule structure shall include all properties of the ScheduleInfo structure\n\t\t\t\t\t\tand also the standard events (iCalendar format) and a list of SpecialDaysSchedule instances.", + "base": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleInfo", + "base_definition": { + "kind": "complexType", + "name": "ScheduleInfo", + "description": "The ScheduleInfo type represents the schedule as a physical object.\n\t\t\t\t\t\tThe structure contains information of a specific schedule instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the schedule. It shall be up to 1024 characters." + } + ] + }, + "fields": [ + { + "name": "Standard", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "An iCalendar structure that defines a number of events. Events\n\t\t\t\t\t\t\t\t\t\tcan be recurring or non-recurring. The events can, for instance,\n\t\t\t\t\t\t\t\t\t\tbe used to control when a camera should record or when a facility\n\t\t\t\t\t\t\t\t\t\tis accessible. Some devices might not be able to fully support\n\t\t\t\t\t\t\t\t\t\tall the features of iCalendar. Setting the service capability\n\t\t\t\t\t\t\t\t\t\tExtendedRecurrenceSupported to false will enable more devices\n\t\t\t\t\t\t\t\t\t\tto be ONVIF compliant. Is of type string (but contains an iCalendar structure)." + }, + { + "name": "SpecialDays", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDaysSchedule", + "type_name": "SpecialDaysSchedule", + "definition": { + "kind": "complexType", + "name": "SpecialDaysSchedule", + "description": "A override schedule that defines alternate time periods for a group of special days.", + "fields": [ + { + "name": "GroupToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the list of special days in a schedule." + }, + { + "name": "TimeRange", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}TimePeriod", + "type_name": "TimePeriod", + "definition": { + "kind": "complexType", + "name": "TimePeriod", + "description": "A time period defines a start and end time. For full day access, the\n\t\t\t\t\t\tstart time =\"00:00:00\" with no defined end time. For a time period with no\n\t\t\t\t\t\tend time, the schedule runs until midnight. The end time must always be greater\n\t\t\t\t\t\tthan the start time, otherwise an InvalidArgVal error messages is generated by the device.", + "fields": [ + { + "name": "From", + "type": "{http://www.w3.org/2001/XMLSchema}time", + "type_name": "time", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the start time." + }, + { + "name": "Until", + "type": "{http://www.w3.org/2001/XMLSchema}time", + "type_name": "time", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the end time. Is optional, if omitted, the period ends at midnight.\n\t\t\t\t\t\t\t\tThe end time is exclusive, meaning that that exact moment in time is not\n\t\t\t\t\t\t\t\tpart of the period. To determine if a moment in time (t) is part of a time period,\n\t\t\t\t\t\t\t\tthe formula StartTime ≤ t < EndTime is used." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}TimePeriodExtension", + "type_name": "TimePeriodExtension", + "definition": { + "kind": "complexType", + "name": "TimePeriodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Indicates the alternate time periods for the list of special days\n\t\t\t\t\t\t\t\t(overrides the regular schedule). For example, the regular schedule indicates\n\t\t\t\t\t\t\t\tthat it is active from 8AM to 5PM on Mondays. However, this particular\n\t\t\t\t\t\t\t\tMonday is a special day, and the alternate time periods state that the\n\t\t\t\t\t\t\t\tschedule is active from 9 AM to 11 AM and 1 PM to 4 PM.\n\t\t\t\t\t\t\t\tIf no time periods are defined, then no access is allowed.\n\t\t\t\t\t\t\t\tIs of type TimePeriod." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDaysScheduleExtension", + "type_name": "SpecialDaysScheduleExtension", + "definition": { + "kind": "complexType", + "name": "SpecialDaysScheduleExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "For devices that are not able to support all the features of iCalendar,\n\t\t\t\t\t\t\t\t\t\tsupporting special days is essential. Each SpecialDaysSchedule\n\t\t\t\t\t\t\t\t\t\tinstance defines an alternate set of time periods that overrides\n\t\t\t\t\t\t\t\t\t\tthe regular schedule for a specified list of special days.\n\t\t\t\t\t\t\t\t\t\tIs of type SpecialDaysSchedule." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleExtension", + "type_name": "ScheduleExtension", + "definition": { + "kind": "complexType", + "name": "ScheduleExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The Schedule to create" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}CreateScheduleResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}CreateScheduleResponse", + "schema": { + "name": "CreateScheduleResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of created Schedule" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "SetSchedule", + "port_type": "SchedulePort", + "description": "This operation modifies or creates the specified schedule.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}SetScheduleRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}SetSchedule", + "schema": { + "name": "SetSchedule", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Schedule", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}Schedule", + "type_name": "Schedule", + "definition": { + "kind": "complexType", + "name": "Schedule", + "description": "The schedule structure shall include all properties of the ScheduleInfo structure\n\t\t\t\t\t\tand also the standard events (iCalendar format) and a list of SpecialDaysSchedule instances.", + "base": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleInfo", + "base_definition": { + "kind": "complexType", + "name": "ScheduleInfo", + "description": "The ScheduleInfo type represents the schedule as a physical object.\n\t\t\t\t\t\tThe structure contains information of a specific schedule instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the schedule. It shall be up to 1024 characters." + } + ] + }, + "fields": [ + { + "name": "Standard", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "An iCalendar structure that defines a number of events. Events\n\t\t\t\t\t\t\t\t\t\tcan be recurring or non-recurring. The events can, for instance,\n\t\t\t\t\t\t\t\t\t\tbe used to control when a camera should record or when a facility\n\t\t\t\t\t\t\t\t\t\tis accessible. Some devices might not be able to fully support\n\t\t\t\t\t\t\t\t\t\tall the features of iCalendar. Setting the service capability\n\t\t\t\t\t\t\t\t\t\tExtendedRecurrenceSupported to false will enable more devices\n\t\t\t\t\t\t\t\t\t\tto be ONVIF compliant. Is of type string (but contains an iCalendar structure)." + }, + { + "name": "SpecialDays", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDaysSchedule", + "type_name": "SpecialDaysSchedule", + "definition": { + "kind": "complexType", + "name": "SpecialDaysSchedule", + "description": "A override schedule that defines alternate time periods for a group of special days.", + "fields": [ + { + "name": "GroupToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the list of special days in a schedule." + }, + { + "name": "TimeRange", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}TimePeriod", + "type_name": "TimePeriod", + "definition": { + "kind": "complexType", + "name": "TimePeriod", + "description": "A time period defines a start and end time. For full day access, the\n\t\t\t\t\t\tstart time =\"00:00:00\" with no defined end time. For a time period with no\n\t\t\t\t\t\tend time, the schedule runs until midnight. The end time must always be greater\n\t\t\t\t\t\tthan the start time, otherwise an InvalidArgVal error messages is generated by the device.", + "fields": [ + { + "name": "From", + "type": "{http://www.w3.org/2001/XMLSchema}time", + "type_name": "time", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the start time." + }, + { + "name": "Until", + "type": "{http://www.w3.org/2001/XMLSchema}time", + "type_name": "time", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the end time. Is optional, if omitted, the period ends at midnight.\n\t\t\t\t\t\t\t\tThe end time is exclusive, meaning that that exact moment in time is not\n\t\t\t\t\t\t\t\tpart of the period. To determine if a moment in time (t) is part of a time period,\n\t\t\t\t\t\t\t\tthe formula StartTime ≤ t < EndTime is used." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}TimePeriodExtension", + "type_name": "TimePeriodExtension", + "definition": { + "kind": "complexType", + "name": "TimePeriodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Indicates the alternate time periods for the list of special days\n\t\t\t\t\t\t\t\t(overrides the regular schedule). For example, the regular schedule indicates\n\t\t\t\t\t\t\t\tthat it is active from 8AM to 5PM on Mondays. However, this particular\n\t\t\t\t\t\t\t\tMonday is a special day, and the alternate time periods state that the\n\t\t\t\t\t\t\t\tschedule is active from 9 AM to 11 AM and 1 PM to 4 PM.\n\t\t\t\t\t\t\t\tIf no time periods are defined, then no access is allowed.\n\t\t\t\t\t\t\t\tIs of type TimePeriod." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDaysScheduleExtension", + "type_name": "SpecialDaysScheduleExtension", + "definition": { + "kind": "complexType", + "name": "SpecialDaysScheduleExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "For devices that are not able to support all the features of iCalendar,\n\t\t\t\t\t\t\t\t\t\tsupporting special days is essential. Each SpecialDaysSchedule\n\t\t\t\t\t\t\t\t\t\tinstance defines an alternate set of time periods that overrides\n\t\t\t\t\t\t\t\t\t\tthe regular schedule for a specified list of special days.\n\t\t\t\t\t\t\t\t\t\tIs of type SpecialDaysSchedule." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleExtension", + "type_name": "ScheduleExtension", + "definition": { + "kind": "complexType", + "name": "ScheduleExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The Schedule to modify/create" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}SetScheduleResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}SetScheduleResponse", + "schema": { + "name": "SetScheduleResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "ModifySchedule", + "port_type": "SchedulePort", + "description": "This operation modifies or updates the specified schedule.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}ModifyScheduleRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}ModifySchedule", + "schema": { + "name": "ModifySchedule", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Schedule", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}Schedule", + "type_name": "Schedule", + "definition": { + "kind": "complexType", + "name": "Schedule", + "description": "The schedule structure shall include all properties of the ScheduleInfo structure\n\t\t\t\t\t\tand also the standard events (iCalendar format) and a list of SpecialDaysSchedule instances.", + "base": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleInfo", + "base_definition": { + "kind": "complexType", + "name": "ScheduleInfo", + "description": "The ScheduleInfo type represents the schedule as a physical object.\n\t\t\t\t\t\tThe structure contains information of a specific schedule instance.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A user readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the schedule. It shall be up to 1024 characters." + } + ] + }, + "fields": [ + { + "name": "Standard", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "An iCalendar structure that defines a number of events. Events\n\t\t\t\t\t\t\t\t\t\tcan be recurring or non-recurring. The events can, for instance,\n\t\t\t\t\t\t\t\t\t\tbe used to control when a camera should record or when a facility\n\t\t\t\t\t\t\t\t\t\tis accessible. Some devices might not be able to fully support\n\t\t\t\t\t\t\t\t\t\tall the features of iCalendar. Setting the service capability\n\t\t\t\t\t\t\t\t\t\tExtendedRecurrenceSupported to false will enable more devices\n\t\t\t\t\t\t\t\t\t\tto be ONVIF compliant. Is of type string (but contains an iCalendar structure)." + }, + { + "name": "SpecialDays", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDaysSchedule", + "type_name": "SpecialDaysSchedule", + "definition": { + "kind": "complexType", + "name": "SpecialDaysSchedule", + "description": "A override schedule that defines alternate time periods for a group of special days.", + "fields": [ + { + "name": "GroupToken", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the list of special days in a schedule." + }, + { + "name": "TimeRange", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}TimePeriod", + "type_name": "TimePeriod", + "definition": { + "kind": "complexType", + "name": "TimePeriod", + "description": "A time period defines a start and end time. For full day access, the\n\t\t\t\t\t\tstart time =\"00:00:00\" with no defined end time. For a time period with no\n\t\t\t\t\t\tend time, the schedule runs until midnight. The end time must always be greater\n\t\t\t\t\t\tthan the start time, otherwise an InvalidArgVal error messages is generated by the device.", + "fields": [ + { + "name": "From", + "type": "{http://www.w3.org/2001/XMLSchema}time", + "type_name": "time", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the start time." + }, + { + "name": "Until", + "type": "{http://www.w3.org/2001/XMLSchema}time", + "type_name": "time", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the end time. Is optional, if omitted, the period ends at midnight.\n\t\t\t\t\t\t\t\tThe end time is exclusive, meaning that that exact moment in time is not\n\t\t\t\t\t\t\t\tpart of the period. To determine if a moment in time (t) is part of a time period,\n\t\t\t\t\t\t\t\tthe formula StartTime ≤ t < EndTime is used." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}TimePeriodExtension", + "type_name": "TimePeriodExtension", + "definition": { + "kind": "complexType", + "name": "TimePeriodExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Indicates the alternate time periods for the list of special days\n\t\t\t\t\t\t\t\t(overrides the regular schedule). For example, the regular schedule indicates\n\t\t\t\t\t\t\t\tthat it is active from 8AM to 5PM on Mondays. However, this particular\n\t\t\t\t\t\t\t\tMonday is a special day, and the alternate time periods state that the\n\t\t\t\t\t\t\t\tschedule is active from 9 AM to 11 AM and 1 PM to 4 PM.\n\t\t\t\t\t\t\t\tIf no time periods are defined, then no access is allowed.\n\t\t\t\t\t\t\t\tIs of type TimePeriod." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDaysScheduleExtension", + "type_name": "SpecialDaysScheduleExtension", + "definition": { + "kind": "complexType", + "name": "SpecialDaysScheduleExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "For devices that are not able to support all the features of iCalendar,\n\t\t\t\t\t\t\t\t\t\tsupporting special days is essential. Each SpecialDaysSchedule\n\t\t\t\t\t\t\t\t\t\tinstance defines an alternate set of time periods that overrides\n\t\t\t\t\t\t\t\t\t\tthe regular schedule for a specified list of special days.\n\t\t\t\t\t\t\t\t\t\tIs of type SpecialDaysSchedule." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}ScheduleExtension", + "type_name": "ScheduleExtension", + "definition": { + "kind": "complexType", + "name": "ScheduleExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The Schedule to modify/update" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}ModifyScheduleResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}ModifyScheduleResponse", + "schema": { + "name": "ModifyScheduleResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "DeleteSchedule", + "port_type": "SchedulePort", + "description": "This operation will delete the specified schedule. If it is associated with one or more entities some devices may not be able to delete the schedule, and consequently a ReferenceInUse fault shall be generated.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}DeleteScheduleRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}DeleteSchedule", + "schema": { + "name": "DeleteSchedule", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the schedule to delete." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}DeleteScheduleResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}DeleteScheduleResponse", + "schema": { + "name": "DeleteScheduleResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "GetSpecialDayGroupInfo", + "port_type": "SchedulePort", + "description": "This operation requests a list of SpecialDayGroupInfo items matching the given tokens. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupInfoRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupInfo", + "schema": { + "name": "GetSpecialDayGroupInfo", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of SpecialDayGroupInfo items to get." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupInfoResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupInfoResponse", + "schema": { + "name": "GetSpecialDayGroupInfoResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SpecialDayGroupInfo", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroupInfo", + "type_name": "SpecialDayGroupInfo", + "definition": { + "kind": "complexType", + "name": "SpecialDayGroupInfo", + "description": "The SpecialDayGroupInfo structure contains the basic information about the special days list.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the special days. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SpecialDayGroupInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "GetSpecialDayGroupInfoList", + "port_type": "SchedulePort", + "description": "This operation requests a list of all of SpecialDayGroupInfo items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. The number of items returned shall not be greater than Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupInfoListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupInfoList", + "schema": { + "name": "GetSpecialDayGroupInfoList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than\n\t\t\t\t\t\t\t\t\tone or higher than what the device supports, the number\n\t\t\t\t\t\t\t\t\tof items is determined by the device." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference.\n\t\t\t\t\t\t\t\t\tIf not specified, entries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupInfoListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupInfoListResponse", + "schema": { + "name": "GetSpecialDayGroupInfoListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items.\n\t\t\t\t\t\t\t\t\tIf absent, no more items to get." + }, + { + "name": "SpecialDayGroupInfo", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroupInfo", + "type_name": "SpecialDayGroupInfo", + "definition": { + "kind": "complexType", + "name": "SpecialDayGroupInfo", + "description": "The SpecialDayGroupInfo structure contains the basic information about the special days list.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the special days. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SpecialDayGroupInfo items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "GetSpecialDayGroups", + "port_type": "SchedulePort", + "description": "This operation returns the specified special day group item matching the given token.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroups", + "schema": { + "name": "GetSpecialDayGroups", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the SpecialDayGroup items to get" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupsResponse", + "schema": { + "name": "GetSpecialDayGroupsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SpecialDayGroup", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroup", + "type_name": "SpecialDayGroup", + "definition": { + "kind": "complexType", + "name": "SpecialDayGroup", + "description": "The special day group structure shall include all properties of the SpecialDayGroupInfo\n\t\t\t\t\t\tstructure and also a set of special days. A special day group are days (or parts of days)\n\t\t\t\t\t\tthat require the regular schedule to be overridden with an alternate schedule.\n\t\t\t\t\t\tFor example holidays, half-days, working Sundays, etc.", + "base": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroupInfo", + "base_definition": { + "kind": "complexType", + "name": "SpecialDayGroupInfo", + "description": "The SpecialDayGroupInfo structure contains the basic information about the special days list.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the special days. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "fields": [ + { + "name": "Days", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An iCalendar structure that contains a group of special days.\n\t\t\t\t\t\t\t\t\t\tIs of type string (containing an iCalendar structure)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroupExtension", + "type_name": "SpecialDayGroupExtension", + "definition": { + "kind": "complexType", + "name": "SpecialDayGroupExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SpecialDayGroup items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "GetSpecialDayGroupList", + "port_type": "SchedulePort", + "description": "This operation requests a list of all of SpecialDayGroupList items provided by the device. A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer Access Control Service Specification for more details. The number of items returned shall not be greater the Limit parameter.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupListRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupList", + "schema": { + "name": "GetSpecialDayGroupList", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of entries to return. If not specified, less than\n\t\t\t\t\t\t\t\t\tone or higher than what the device supports, the number of\n\t\t\t\t\t\t\t\t\titems is determined by the device." + }, + { + "name": "StartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Start returning entries from this start reference.\n\t\t\t\t\t\t\t\t\tIf not specified, entries shall start from the beginning of the dataset." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupListResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}GetSpecialDayGroupListResponse", + "schema": { + "name": "GetSpecialDayGroupListResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NextStartReference", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "StartReference to use in next call to get the following items. If\n\t\t\t\t\t\t\t\t\tabsent, no more items to get." + }, + { + "name": "SpecialDayGroup", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroup", + "type_name": "SpecialDayGroup", + "definition": { + "kind": "complexType", + "name": "SpecialDayGroup", + "description": "The special day group structure shall include all properties of the SpecialDayGroupInfo\n\t\t\t\t\t\tstructure and also a set of special days. A special day group are days (or parts of days)\n\t\t\t\t\t\tthat require the regular schedule to be overridden with an alternate schedule.\n\t\t\t\t\t\tFor example holidays, half-days, working Sundays, etc.", + "base": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroupInfo", + "base_definition": { + "kind": "complexType", + "name": "SpecialDayGroupInfo", + "description": "The SpecialDayGroupInfo structure contains the basic information about the special days list.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the special days. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "fields": [ + { + "name": "Days", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An iCalendar structure that contains a group of special days.\n\t\t\t\t\t\t\t\t\t\tIs of type string (containing an iCalendar structure)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroupExtension", + "type_name": "SpecialDayGroupExtension", + "definition": { + "kind": "complexType", + "name": "SpecialDayGroupExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SpecialDayGroup items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "CreateSpecialDayGroup", + "port_type": "SchedulePort", + "description": "This operation creates the specified special day group. The token field of the SpecialDayGroup structure shall be empty, the device shall allocate a token for the special day group. The allocated token shall be returned in the response. If there is any value in the token field, the device shall return InvalidArgVal as generic fault code.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}CreateSpecialDayGroupRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}CreateSpecialDayGroup", + "schema": { + "name": "CreateSpecialDayGroup", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SpecialDayGroup", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroup", + "type_name": "SpecialDayGroup", + "definition": { + "kind": "complexType", + "name": "SpecialDayGroup", + "description": "The special day group structure shall include all properties of the SpecialDayGroupInfo\n\t\t\t\t\t\tstructure and also a set of special days. A special day group are days (or parts of days)\n\t\t\t\t\t\tthat require the regular schedule to be overridden with an alternate schedule.\n\t\t\t\t\t\tFor example holidays, half-days, working Sundays, etc.", + "base": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroupInfo", + "base_definition": { + "kind": "complexType", + "name": "SpecialDayGroupInfo", + "description": "The SpecialDayGroupInfo structure contains the basic information about the special days list.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the special days. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "fields": [ + { + "name": "Days", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An iCalendar structure that contains a group of special days.\n\t\t\t\t\t\t\t\t\t\tIs of type string (containing an iCalendar structure)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroupExtension", + "type_name": "SpecialDayGroupExtension", + "definition": { + "kind": "complexType", + "name": "SpecialDayGroupExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The special day group to create." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}CreateSpecialDayGroupResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}CreateSpecialDayGroupResponse", + "schema": { + "name": "CreateSpecialDayGroupResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of created special day group." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "SetSpecialDayGroup", + "port_type": "SchedulePort", + "description": "This operation modifies or creates the specified special day group.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}SetSpecialDayGroupRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}SetSpecialDayGroup", + "schema": { + "name": "SetSpecialDayGroup", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SpecialDayGroup", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroup", + "type_name": "SpecialDayGroup", + "definition": { + "kind": "complexType", + "name": "SpecialDayGroup", + "description": "The special day group structure shall include all properties of the SpecialDayGroupInfo\n\t\t\t\t\t\tstructure and also a set of special days. A special day group are days (or parts of days)\n\t\t\t\t\t\tthat require the regular schedule to be overridden with an alternate schedule.\n\t\t\t\t\t\tFor example holidays, half-days, working Sundays, etc.", + "base": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroupInfo", + "base_definition": { + "kind": "complexType", + "name": "SpecialDayGroupInfo", + "description": "The SpecialDayGroupInfo structure contains the basic information about the special days list.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the special days. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "fields": [ + { + "name": "Days", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An iCalendar structure that contains a group of special days.\n\t\t\t\t\t\t\t\t\t\tIs of type string (containing an iCalendar structure)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroupExtension", + "type_name": "SpecialDayGroupExtension", + "definition": { + "kind": "complexType", + "name": "SpecialDayGroupExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The SpecialDayGroup to modify/create" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}SetSpecialDayGroupResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}SetSpecialDayGroupResponse", + "schema": { + "name": "SetSpecialDayGroupResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "ModifySpecialDayGroup", + "port_type": "SchedulePort", + "description": "This operation updates the specified special day group.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}ModifySpecialDayGroupRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}ModifySpecialDayGroup", + "schema": { + "name": "ModifySpecialDayGroup", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SpecialDayGroup", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroup", + "type_name": "SpecialDayGroup", + "definition": { + "kind": "complexType", + "name": "SpecialDayGroup", + "description": "The special day group structure shall include all properties of the SpecialDayGroupInfo\n\t\t\t\t\t\tstructure and also a set of special days. A special day group are days (or parts of days)\n\t\t\t\t\t\tthat require the regular schedule to be overridden with an alternate schedule.\n\t\t\t\t\t\tFor example holidays, half-days, working Sundays, etc.", + "base": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroupInfo", + "base_definition": { + "kind": "complexType", + "name": "SpecialDayGroupInfo", + "description": "The SpecialDayGroupInfo structure contains the basic information about the special days list.", + "base": "{http://www.onvif.org/ver10/pacs}DataEntity", + "base_definition": { + "kind": "complexType", + "name": "DataEntity", + "description": "General data structure referenced by a token.\n\t\t\t\tShould be used as extension base.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "description": "A service-unique identifier of the item." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/pacs}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "Type used for names of logical and physical entities.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. It shall be up to 64 characters." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/pacs}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "description": "Description is optional and the maximum length is device specific.\n\t\t\t\tIf the length is more than maximum length, it is silently chopped to the maximum length\n\t\t\t\tsupported by the device/service (which may be 0).", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "1024" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "User readable description for the special days. It shall be up to 1024\n\t\t\t\t\t\t\t\t\t\tcharacters." + } + ] + }, + "fields": [ + { + "name": "Days", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An iCalendar structure that contains a group of special days.\n\t\t\t\t\t\t\t\t\t\tIs of type string (containing an iCalendar structure)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schedule/wsdl}SpecialDayGroupExtension", + "type_name": "SpecialDayGroupExtension", + "definition": { + "kind": "complexType", + "name": "SpecialDayGroupExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The special day group to modify/update." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}ModifySpecialDayGroupResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}ModifySpecialDayGroupResponse", + "schema": { + "name": "ModifySpecialDayGroupResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + }, + { + "name": "DeleteSpecialDayGroup", + "port_type": "SchedulePort", + "description": "This method deletes the specified special day group. If it is associated with one or more schedules some devices may not be able to delete the special day group, and consequently a ReferenceInUse fault must be generated.", + "input": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}DeleteSpecialDayGroupRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}DeleteSpecialDayGroup", + "schema": { + "name": "DeleteSpecialDayGroup", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/pacs}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Type used to reference logical and physical entities.\n\t\t\tToken may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating as a local token.\n\t\t\tSee \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "minLength": "0", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The token of the special day group item to delete." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/schedule/wsdl}DeleteSpecialDayGroupResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/schedule/wsdl}DeleteSpecialDayGroupResponse", + "schema": { + "name": "DeleteSpecialDayGroupResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ScheduleBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/search.json b/docs/generated/wsdl/ver10/search.json new file mode 100644 index 00000000..ceebc26e --- /dev/null +++ b/docs/generated/wsdl/ver10/search.json @@ -0,0 +1,4535 @@ +{ + "source": "ver10/search.wsdl", + "target_namespace": "http://www.onvif.org/ver10/search/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "SearchPort", + "description": "Returns the capabilities of the search service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/search/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "MetadataSearch", + "type": "{http://www.w3.org/2001/XMLSchema}boolean" + }, + { + "use": "optional", + "name": "GeneralStartEvents", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for general virtual property events in the FindEvents method." + }, + { + "use": "optional", + "name": "NLSearch", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for natural language based search." + }, + { + "use": "optional", + "name": "ImageSearch", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for image based search." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the search service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "GetRecordingSummary", + "port_type": "SearchPort", + "description": "GetRecordingSummary is used to get a summary description of all recorded data. This operation is mandatory to support for a device implementing the recording search service.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetRecordingSummaryRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetRecordingSummary", + "schema": { + "name": "GetRecordingSummary", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetRecordingSummaryResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetRecordingSummaryResponse", + "schema": { + "name": "GetRecordingSummaryResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Summary", + "type": "{http://www.onvif.org/ver10/schema}RecordingSummary", + "type_name": "RecordingSummary", + "definition": { + "kind": "complexType", + "name": "RecordingSummary", + "fields": [ + { + "name": "DataFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The earliest point in time where there is recorded data on the device." + }, + { + "name": "DataUntil", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The most recent point in time where there is recorded data on the device." + }, + { + "name": "NumberRecordings", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The device contains this many recordings." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "GetRecordingInformation", + "port_type": "SearchPort", + "description": "Returns information about a single Recording specified by a RecordingToken. This operation is mandatory to support for a device implementing the recording search service.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetRecordingInformationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetRecordingInformation", + "schema": { + "name": "GetRecordingInformation", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetRecordingInformationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetRecordingInformationResponse", + "schema": { + "name": "GetRecordingInformationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingInformation", + "type": "{http://www.onvif.org/ver10/schema}RecordingInformation", + "type_name": "RecordingInformation", + "definition": { + "kind": "complexType", + "name": "RecordingInformation", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}RecordingSourceInformation", + "type_name": "RecordingSourceInformation", + "definition": { + "kind": "complexType", + "name": "RecordingSourceInformation", + "description": "A set of informative descriptions of a data source. The Search service allows a client to filter on recordings based on information in this structure.", + "fields": [ + { + "name": "SourceId", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifier for the source chosen by the client that creates the structure.\n\t\t\t\tThis identifier is opaque to the device. Clients may use any type of URI for this field. A device shall support at least 128 characters." + }, + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative user readable name of the source, e.g. \"Camera23\". A device shall support at least 20 characters." + }, + { + "name": "Location", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the physical location of the source, e.g. the coordinates on a map." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the source." + }, + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "URI provided by the service supplying data to be recorded. A device shall support at least 128 characters." + }, + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The video source token of all recordings that will use this configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Information about the source of the recording. This gives a description of where the data in the recording comes from. Since a single\n\t\t\t\t\trecording is intended to record related material, there is just one source. It is indicates the physical location or the\n\t\t\t\t\tmajor data source for the recording. Currently the recordingconfiguration cannot describe each individual data source." + }, + { + "name": "EarliestRecording", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "LatestRecording", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Content", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Track", + "type": "{http://www.onvif.org/ver10/schema}TrackInformation", + "type_name": "TrackInformation", + "definition": { + "kind": "complexType", + "name": "TrackInformation", + "fields": [ + { + "name": "TrackToken", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TrackType", + "type": "{http://www.onvif.org/ver10/schema}TrackType", + "type_name": "TrackType", + "definition": { + "kind": "simpleType", + "name": "TrackType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Video" + }, + { + "value": "Audio" + }, + { + "value": "Metadata" + }, + { + "value": "Extended", + "description": "Placeholder for future extension." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of the track: \"Video\", \"Audio\" or \"Metadata\".\n\t\t\t\t\tThe track shall only be able to hold data of that type." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the contents of the track." + }, + { + "name": "DataFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The start date and time of the oldest recorded data in the track." + }, + { + "name": "DataTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The stop date and time of the newest recorded data in the track." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Basic information about the track. Note that a track may represent a single contiguous time span or consist of multiple slices." + }, + { + "name": "RecordingStatus", + "type": "{http://www.onvif.org/ver10/schema}RecordingStatus", + "type_name": "RecordingStatus", + "definition": { + "kind": "simpleType", + "name": "RecordingStatus", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Initiated" + }, + { + "value": "Recording" + }, + { + "value": "Stopped" + }, + { + "value": "Removing" + }, + { + "value": "Removed" + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "GetMediaAttributes", + "port_type": "SearchPort", + "description": "Returns a set of media attributes for all tracks of the specified recordings at a specified point in time. Clients using this operation shall be able to use it as a non blocking operation. A device shall set the starttime and endtime of the MediaAttributes structure to equal values if calculating this range would causes this operation to block. See MediaAttributes structure for more information. This operation is mandatory to support for a device implementing the recording search service.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetMediaAttributesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetMediaAttributes", + "schema": { + "name": "GetMediaAttributes", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RecordingTokens", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Time", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetMediaAttributesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetMediaAttributesResponse", + "schema": { + "name": "GetMediaAttributesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "MediaAttributes", + "type": "{http://www.onvif.org/ver10/schema}MediaAttributes", + "type_name": "MediaAttributes", + "definition": { + "kind": "complexType", + "name": "MediaAttributes", + "description": "A set of media attributes valid for a recording at a point in time or for a time interval.", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the recording that has these attributes." + }, + { + "name": "TrackAttributes", + "type": "{http://www.onvif.org/ver10/schema}TrackAttributes", + "type_name": "TrackAttributes", + "definition": { + "kind": "complexType", + "name": "TrackAttributes", + "fields": [ + { + "name": "TrackInformation", + "type": "{http://www.onvif.org/ver10/schema}TrackInformation", + "type_name": "TrackInformation", + "definition": { + "kind": "complexType", + "name": "TrackInformation", + "fields": [ + { + "name": "TrackToken", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TrackType", + "type": "{http://www.onvif.org/ver10/schema}TrackType", + "type_name": "TrackType", + "definition": { + "kind": "simpleType", + "name": "TrackType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Video" + }, + { + "value": "Audio" + }, + { + "value": "Metadata" + }, + { + "value": "Extended", + "description": "Placeholder for future extension." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of the track: \"Video\", \"Audio\" or \"Metadata\".\n\t\t\t\t\tThe track shall only be able to hold data of that type." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the contents of the track." + }, + { + "name": "DataFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The start date and time of the oldest recorded data in the track." + }, + { + "name": "DataTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The stop date and time of the newest recorded data in the track." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The basic information about the track. Note that a track may represent a single contiguous time span or consist of multiple slices." + }, + { + "name": "VideoAttributes", + "type": "{http://www.onvif.org/ver10/schema}VideoAttributes", + "type_name": "VideoAttributes", + "definition": { + "kind": "complexType", + "name": "VideoAttributes", + "fields": [ + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Average bitrate in kbps." + }, + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The width of the video in pixels." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The height of the video in pixels." + }, + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Video encoding of the track. Use value from tt:VideoEncoding for MPEG4. Otherwise use values from tt:VideoEncodingMimeNames and IANA Media Types." + }, + { + "name": "Framerate", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Average framerate in frames per second." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the track is a video track, exactly one of this structure shall be present and contain the video attributes." + }, + { + "name": "AudioAttributes", + "type": "{http://www.onvif.org/ver10/schema}AudioAttributes", + "type_name": "AudioAttributes", + "definition": { + "kind": "complexType", + "name": "AudioAttributes", + "fields": [ + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The bitrate in kbps." + }, + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio encoding of the track. Use values from tt:AudioEncoding for G711 and AAC. Otherwise use values from tt:AudioEncodingMimeNames and IANA Media Types." + }, + { + "name": "Samplerate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The sample rate in kHz." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the track is an audio track, exactly one of this structure shall be present and contain the audio attributes." + }, + { + "name": "MetadataAttributes", + "type": "{http://www.onvif.org/ver10/schema}MetadataAttributes", + "type_name": "MetadataAttributes", + "definition": { + "kind": "complexType", + "name": "MetadataAttributes", + "fields": [ + { + "name": "CanContainPTZ", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates that there can be PTZ data in the metadata track in the specified time interval." + }, + { + "name": "CanContainAnalytics", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates that there can be analytics data in the metadata track in the specified time interval." + }, + { + "name": "CanContainNotifications", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates that there can be notifications in the metadata track in the specified time interval." + } + ], + "attributes": [ + { + "use": "optional", + "name": "PtzSpaces", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of all PTZ spaces active for recording. Note that events are only recorded on position changes and the actual point of recording may not necessarily contain an event of the specified type." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the track is an metadata track, exactly one of this structure shall be present and contain the metadata attributes." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}TrackAttributesExtension", + "type_name": "TrackAttributesExtension", + "definition": { + "kind": "complexType", + "name": "TrackAttributesExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A set of attributes for each track." + }, + { + "name": "From", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The attributes are valid from this point in time in the recording." + }, + { + "name": "Until", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The attributes are valid until this point in time in the recording. Can be equal to 'From' to indicate that the attributes are only known to be valid for this particular point in time." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "FindRecordings", + "port_type": "SearchPort", + "description": "FindRecordings starts a search session, looking for recordings that matches the scope (See 20.2.4) defined in the request. Results from the search are acquired using the GetRecordingSearchResults request, specifying the search token returned from this request. The device shall continue searching until one of the following occurs: The entire time range from StartPoint to EndPoint has been searched through. The total number of matches has been found, defined by the MaxMatches parameter. The session has been ended by a client EndSession request. The session has been ended because KeepAliveTime since the last request related to this session has expired. The order of the results is undefined, to allow the device to return results in any order they are found. This operation is mandatory to support for a device implementing the recording search service.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}FindRecordingsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}FindRecordings", + "schema": { + "name": "FindRecordings", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Scope", + "type": "{http://www.onvif.org/ver10/schema}SearchScope", + "type_name": "SearchScope", + "definition": { + "kind": "complexType", + "name": "SearchScope", + "description": "A structure for defining a limited scope when searching in recorded data.", + "fields": [ + { + "name": "IncludedSources", + "type": "{http://www.onvif.org/ver10/schema}SourceReference", + "type_name": "SourceReference", + "definition": { + "kind": "complexType", + "name": "SourceReference", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "default": "http://www.onvif.org/ver10/schema/Receiver" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of sources that are included in the scope. If this list is included, only data from one of these sources shall be searched." + }, + { + "name": "IncludedRecordings", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of recordings that are included in the scope. If this list is included, only data from one of these recordings shall be searched." + }, + { + "name": "RecordingInformationFilter", + "type": "{http://www.onvif.org/ver10/schema}XPathExpression", + "type_name": "XPathExpression", + "definition": { + "kind": "simpleType", + "name": "XPathExpression", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An xpath expression used to specify what recordings to search. Only those recordings with an RecordingInformation structure that matches the filter shall be searched." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SearchScopeExtension", + "type_name": "SearchScopeExtension", + "definition": { + "kind": "complexType", + "name": "SearchScopeExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Extension point" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Scope defines the dataset to consider for this search." + }, + { + "name": "MaxMatches", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The search will be completed after this many matches. If not specified, the search will continue until reaching the endpoint or until the session expires." + }, + { + "name": "KeepAliveTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time the search session will be kept alive after responding to this and subsequent requests. A device shall support at least values up to ten seconds." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}FindRecordingsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}FindRecordingsResponse", + "schema": { + "name": "FindRecordingsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "GetRecordingSearchResults", + "port_type": "SearchPort", + "description": "GetRecordingSearchResults acquires the results from a recording search session previously initiated by a FindRecordings operation. The response shall not include results already returned in previous requests for the same session. If MaxResults is specified, the response shall not contain more than MaxResults results. The number of results relates to the number of recordings. For viewing individual recorded data for a signal track use the FindEvents method. GetRecordingSearchResults shall block until: MaxResults results are available for the response if MaxResults is specified. MinResults results are available for the response if MinResults is specified. WaitTime has expired. Search is completed or stopped. This operation is mandatory to support for a device implementing the recording search service.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetRecordingSearchResultsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetRecordingSearchResults", + "schema": { + "name": "GetRecordingSearchResults", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The search session to get results from." + }, + { + "name": "MinResults", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The minimum number of results to return in one response." + }, + { + "name": "MaxResults", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The maximum number of results to return in one response." + }, + { + "name": "WaitTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The maximum time before responding to the request, even if the MinResults parameter is not fulfilled." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Gets results from a particular recording listing session." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetRecordingSearchResultsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetRecordingSearchResultsResponse", + "schema": { + "name": "GetRecordingSearchResultsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ResultList", + "type": "{http://www.onvif.org/ver10/schema}FindRecordingResultList", + "type_name": "FindRecordingResultList", + "definition": { + "kind": "complexType", + "name": "FindRecordingResultList", + "fields": [ + { + "name": "SearchState", + "type": "{http://www.onvif.org/ver10/schema}SearchState", + "type_name": "SearchState", + "definition": { + "kind": "simpleType", + "name": "SearchState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Queued", + "description": "The search is queued and not yet started." + }, + { + "value": "Searching", + "description": "The search is underway and not yet completed." + }, + { + "value": "Completed", + "description": "The search has been completed and no new results will be found." + }, + { + "value": "Unknown", + "description": "The state of the search is unknown. (This is not a valid response from GetSearchState.)" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed." + }, + { + "name": "RecordingInformation", + "type": "{http://www.onvif.org/ver10/schema}RecordingInformation", + "type_name": "RecordingInformation", + "definition": { + "kind": "complexType", + "name": "RecordingInformation", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}RecordingSourceInformation", + "type_name": "RecordingSourceInformation", + "definition": { + "kind": "complexType", + "name": "RecordingSourceInformation", + "description": "A set of informative descriptions of a data source. The Search service allows a client to filter on recordings based on information in this structure.", + "fields": [ + { + "name": "SourceId", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Identifier for the source chosen by the client that creates the structure.\n\t\t\t\tThis identifier is opaque to the device. Clients may use any type of URI for this field. A device shall support at least 128 characters." + }, + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative user readable name of the source, e.g. \"Camera23\". A device shall support at least 20 characters." + }, + { + "name": "Location", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the physical location of the source, e.g. the coordinates on a map." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the source." + }, + { + "name": "Address", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "URI provided by the service supplying data to be recorded. A device shall support at least 128 characters." + }, + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The video source token of all recordings that will use this configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Information about the source of the recording. This gives a description of where the data in the recording comes from. Since a single\n\t\t\t\t\trecording is intended to record related material, there is just one source. It is indicates the physical location or the\n\t\t\t\t\tmajor data source for the recording. Currently the recordingconfiguration cannot describe each individual data source." + }, + { + "name": "EarliestRecording", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "LatestRecording", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Content", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Track", + "type": "{http://www.onvif.org/ver10/schema}TrackInformation", + "type_name": "TrackInformation", + "definition": { + "kind": "complexType", + "name": "TrackInformation", + "fields": [ + { + "name": "TrackToken", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "TrackType", + "type": "{http://www.onvif.org/ver10/schema}TrackType", + "type_name": "TrackType", + "definition": { + "kind": "simpleType", + "name": "TrackType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Video" + }, + { + "value": "Audio" + }, + { + "value": "Metadata" + }, + { + "value": "Extended", + "description": "Placeholder for future extension." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of the track: \"Video\", \"Audio\" or \"Metadata\".\n\t\t\t\t\tThe track shall only be able to hold data of that type." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of the contents of the track." + }, + { + "name": "DataFrom", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The start date and time of the oldest recorded data in the track." + }, + { + "name": "DataTo", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The stop date and time of the newest recorded data in the track." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Basic information about the track. Note that a track may represent a single contiguous time span or consist of multiple slices." + }, + { + "name": "RecordingStatus", + "type": "{http://www.onvif.org/ver10/schema}RecordingStatus", + "type_name": "RecordingStatus", + "definition": { + "kind": "simpleType", + "name": "RecordingStatus", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Initiated" + }, + { + "value": "Recording" + }, + { + "value": "Stopped" + }, + { + "value": "Removing" + }, + { + "value": "Removed" + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A RecordingInformation structure for each found recording matching the search." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "FindEvents", + "port_type": "SearchPort", + "description": "FindEvents starts a search session, looking for recording events (in the scope that matches the search filter defined in the request. Results from the search are acquired using the GetEventSearchResults request, specifying the search token returned from this request. The device shall continue searching until one of the following occurs: The entire time range from StartPoint to EndPoint has been searched through. The total number of matches has been found, defined by the MaxMatches parameter. The session has been ended by a client EndSession request. The session has been ended because KeepAliveTime since the last request related to this session has expired. Results shall be ordered by time, ascending in case of forward search, or descending in case of backward search. This operation is mandatory to support for a device implementing the recording search service.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}FindEventsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}FindEvents", + "schema": { + "name": "FindEvents", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StartPoint", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The point of time where the search will start." + }, + { + "name": "EndPoint", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The point of time where the search will stop. This can be a time before the StartPoint, in which case the search is performed backwards in time." + }, + { + "name": "Scope", + "type": "{http://www.onvif.org/ver10/schema}SearchScope", + "type_name": "SearchScope", + "definition": { + "kind": "complexType", + "name": "SearchScope", + "description": "A structure for defining a limited scope when searching in recorded data.", + "fields": [ + { + "name": "IncludedSources", + "type": "{http://www.onvif.org/ver10/schema}SourceReference", + "type_name": "SourceReference", + "definition": { + "kind": "complexType", + "name": "SourceReference", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "default": "http://www.onvif.org/ver10/schema/Receiver" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of sources that are included in the scope. If this list is included, only data from one of these sources shall be searched." + }, + { + "name": "IncludedRecordings", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of recordings that are included in the scope. If this list is included, only data from one of these recordings shall be searched." + }, + { + "name": "RecordingInformationFilter", + "type": "{http://www.onvif.org/ver10/schema}XPathExpression", + "type_name": "XPathExpression", + "definition": { + "kind": "simpleType", + "name": "XPathExpression", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An xpath expression used to specify what recordings to search. Only those recordings with an RecordingInformation structure that matches the filter shall be searched." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SearchScopeExtension", + "type_name": "SearchScopeExtension", + "definition": { + "kind": "complexType", + "name": "SearchScopeExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Extension point" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SearchFilter", + "type": "{http://www.onvif.org/ver10/schema}EventFilter", + "type_name": "EventFilter", + "definition": { + "kind": "complexType", + "name": "EventFilter", + "base": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "base_definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "IncludeStartState", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Setting IncludeStartState to true means that the server should return virtual events representing the start state for any recording included in the scope. Start state events are limited to the topics defined in the SearchFilter that have the IsProperty flag set to true." + }, + { + "name": "MaxMatches", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The search will be completed after this many matches. If not specified, the search will continue until reaching the endpoint or until the session expires." + }, + { + "name": "KeepAliveTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time the search session will be kept alive after responding to this and subsequent requests. A device shall support at least values up to ten seconds." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Starts a search session and specifies the search parameters." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}FindEventsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}FindEventsResponse", + "schema": { + "name": "FindEventsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique reference to the search session created by this request." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "GetEventSearchResults", + "port_type": "SearchPort", + "description": "GetEventSearchResults acquires the results from a recording event search session previously initiated by a FindEvents operation. The response shall not include results already returned in previous requests for the same session. If MaxResults is specified, the response shall not contain more than MaxResults results. GetEventSearchResults shall block until: MaxResults results are available for the response if MaxResults is specified. MinResults results are available for the response if MinResults is specified. WaitTime has expired. Search is completed or stopped. This operation is mandatory to support for a device implementing the recording search service.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetEventSearchResultsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetEventSearchResults", + "schema": { + "name": "GetEventSearchResults", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The search session to get results from." + }, + { + "name": "MinResults", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The minimum number of results to return in one response." + }, + { + "name": "MaxResults", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The maximum number of results to return in one response." + }, + { + "name": "WaitTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The maximum time before responding to the request, even if the MinResults parameter is not fulfilled." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Gets results from a particular search session." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetEventSearchResultsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetEventSearchResultsResponse", + "schema": { + "name": "GetEventSearchResultsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ResultList", + "type": "{http://www.onvif.org/ver10/schema}FindEventResultList", + "type_name": "FindEventResultList", + "definition": { + "kind": "complexType", + "name": "FindEventResultList", + "fields": [ + { + "name": "SearchState", + "type": "{http://www.onvif.org/ver10/schema}SearchState", + "type_name": "SearchState", + "definition": { + "kind": "simpleType", + "name": "SearchState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Queued", + "description": "The search is queued and not yet started." + }, + { + "value": "Searching", + "description": "The search is underway and not yet completed." + }, + { + "value": "Completed", + "description": "The search has been completed and no new results will be found." + }, + { + "value": "Unknown", + "description": "The state of the search is unknown. (This is not a valid response from GetSearchState.)" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed." + }, + { + "name": "Result", + "type": "{http://www.onvif.org/ver10/schema}FindEventResult", + "type_name": "FindEventResult", + "definition": { + "kind": "complexType", + "name": "FindEventResult", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The recording where this event was found. Empty string if no recording is associated with this event." + }, + { + "name": "TrackToken", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the track where this event was found. Empty string if no track is associated with this event." + }, + { + "name": "Time", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time when the event occurred." + }, + { + "name": "Event", + "type": "{http://docs.oasis-open.org/wsn/b-2}NotificationMessageHolderType", + "type_name": "NotificationMessageHolderType", + "definition": { + "kind": "complexType", + "name": "NotificationMessageHolderType", + "fields": [ + { + "name": "SubscriptionReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}SubscriptionReference" + }, + { + "name": "Topic", + "type": "{http://docs.oasis-open.org/wsn/b-2}TopicExpressionType", + "type_name": "TopicExpressionType", + "definition": { + "kind": "complexType", + "name": "TopicExpressionType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Dialect", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}Topic" + }, + { + "name": "ProducerReference", + "type": "{http://www.w3.org/2005/08/addressing}EndpointReferenceType", + "type_name": "EndpointReferenceType", + "definition": { + "kind": "complexType", + "name": "EndpointReferenceType", + "fields": [ + { + "name": "Address", + "type": "{http://www.w3.org/2005/08/addressing}AttributedURIType", + "type_name": "AttributedURIType", + "definition": { + "kind": "complexType", + "name": "AttributedURIType", + "base": "{http://www.w3.org/2001/XMLSchema}anyURI", + "fields": [], + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ReferenceParameters", + "type": "{http://www.w3.org/2005/08/addressing}ReferenceParametersType", + "type_name": "ReferenceParametersType", + "definition": { + "kind": "complexType", + "name": "ReferenceParametersType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Metadata", + "type": "{http://www.w3.org/2005/08/addressing}MetadataType", + "type_name": "MetadataType", + "definition": { + "kind": "complexType", + "name": "MetadataType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://www.w3.org/2005/08/addressing}Metadata" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##other", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "ref": "{http://docs.oasis-open.org/wsn/b-2}ProducerReference" + }, + { + "name": "Message", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The description of the event." + }, + { + "name": "StartStateEvent", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If true, indicates that the event is a virtual event generated for this particular search session to give the state of a property at the start time of the search." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A FindEventResult structure for each found event matching the search." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "FindPTZPosition", + "port_type": "SearchPort", + "description": "FindPTZPosition starts a search session, looking for ptz positions in the scope (See 20.2.4) that matches the search filter defined in the request. Results from the search are acquired using the GetPTZPositionSearchResults request, specifying the search token returned from this request. The device shall continue searching until one of the following occurs: The entire time range from StartPoint to EndPoint has been searched through. The total number of matches has been found, defined by the MaxMatches parameter. The session has been ended by a client EndSession request. The session has been ended because KeepAliveTime since the last request related to this session has expired. This operation is mandatory to support whenever CanContainPTZ is true for any metadata track in any recording on the device.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}FindPTZPositionRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}FindPTZPosition", + "schema": { + "name": "FindPTZPosition", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StartPoint", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The point of time where the search will start." + }, + { + "name": "EndPoint", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The point of time where the search will stop. This can be a time before the StartPoint, in which case the search is performed backwards in time." + }, + { + "name": "Scope", + "type": "{http://www.onvif.org/ver10/schema}SearchScope", + "type_name": "SearchScope", + "definition": { + "kind": "complexType", + "name": "SearchScope", + "description": "A structure for defining a limited scope when searching in recorded data.", + "fields": [ + { + "name": "IncludedSources", + "type": "{http://www.onvif.org/ver10/schema}SourceReference", + "type_name": "SourceReference", + "definition": { + "kind": "complexType", + "name": "SourceReference", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "default": "http://www.onvif.org/ver10/schema/Receiver" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of sources that are included in the scope. If this list is included, only data from one of these sources shall be searched." + }, + { + "name": "IncludedRecordings", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of recordings that are included in the scope. If this list is included, only data from one of these recordings shall be searched." + }, + { + "name": "RecordingInformationFilter", + "type": "{http://www.onvif.org/ver10/schema}XPathExpression", + "type_name": "XPathExpression", + "definition": { + "kind": "simpleType", + "name": "XPathExpression", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An xpath expression used to specify what recordings to search. Only those recordings with an RecordingInformation structure that matches the filter shall be searched." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SearchScopeExtension", + "type_name": "SearchScopeExtension", + "definition": { + "kind": "complexType", + "name": "SearchScopeExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Extension point" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SearchFilter", + "type": "{http://www.onvif.org/ver10/schema}PTZPositionFilter", + "type_name": "PTZPositionFilter", + "definition": { + "kind": "complexType", + "name": "PTZPositionFilter", + "fields": [ + { + "name": "MinPosition", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The lower boundary of the PTZ volume to look for." + }, + { + "name": "MaxPosition", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The upper boundary of the PTZ volume to look for." + }, + { + "name": "EnterOrExit", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If true, search for when entering the specified PTZ volume." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MaxMatches", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The search will be completed after this many matches. If not specified, the search will continue until reaching the endpoint or until the session expires." + }, + { + "name": "KeepAliveTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time the search session will be kept alive after responding to this and subsequent requests. A device shall support at least values up to ten seconds." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Starts a search session and specifies the search parameters." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}FindPTZPositionResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}FindPTZPositionResponse", + "schema": { + "name": "FindPTZPositionResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique reference to the search session created by this request." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "GetPTZPositionSearchResults", + "port_type": "SearchPort", + "description": "GetPTZPositionSearchResults acquires the results from a ptz position search session previously initiated by a FindPTZPosition operation. The response shall not include results already returned in previous requests for the same session. If MaxResults is specified, the response shall not contain more than MaxResults results. GetPTZPositionSearchResults shall block until: MaxResults results are available for the response if MaxResults is specified. MinResults results are available for the response if MinResults is specified. WaitTime has expired. Search is completed or stopped. This operation is mandatory to support whenever CanContainPTZ is true for any metadata track in any recording on the device.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetPTZPositionSearchResultsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetPTZPositionSearchResults", + "schema": { + "name": "GetPTZPositionSearchResults", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The search session to get results from." + }, + { + "name": "MinResults", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The minimum number of results to return in one response." + }, + { + "name": "MaxResults", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The maximum number of results to return in one response." + }, + { + "name": "WaitTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The maximum time before responding to the request, even if the MinResults parameter is not fulfilled." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Gets results from a particular search session." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetPTZPositionSearchResultsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetPTZPositionSearchResultsResponse", + "schema": { + "name": "GetPTZPositionSearchResultsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ResultList", + "type": "{http://www.onvif.org/ver10/schema}FindPTZPositionResultList", + "type_name": "FindPTZPositionResultList", + "definition": { + "kind": "complexType", + "name": "FindPTZPositionResultList", + "fields": [ + { + "name": "SearchState", + "type": "{http://www.onvif.org/ver10/schema}SearchState", + "type_name": "SearchState", + "definition": { + "kind": "simpleType", + "name": "SearchState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Queued", + "description": "The search is queued and not yet started." + }, + { + "value": "Searching", + "description": "The search is underway and not yet completed." + }, + { + "value": "Completed", + "description": "The search has been completed and no new results will be found." + }, + { + "value": "Unknown", + "description": "The state of the search is unknown. (This is not a valid response from GetSearchState.)" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed." + }, + { + "name": "Result", + "type": "{http://www.onvif.org/ver10/schema}FindPTZPositionResult", + "type_name": "FindPTZPositionResult", + "definition": { + "kind": "complexType", + "name": "FindPTZPositionResult", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the recording containing the PTZ position." + }, + { + "name": "TrackToken", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the metadata track containing the PTZ position." + }, + { + "name": "Time", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time when the PTZ position was valid." + }, + { + "name": "Position", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The PTZ position." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A FindPTZPositionResult structure for each found PTZ position matching the search." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "GetSearchState", + "port_type": "SearchPort", + "description": "GetSearchState returns the current state of the specified search session. This command is deprecated .", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetSearchStateRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetSearchState", + "schema": { + "name": "GetSearchState", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The search session to get the state from." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Returns the state of an ongoing search session." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetSearchStateResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetSearchStateResponse", + "schema": { + "name": "GetSearchStateResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "State", + "type": "{http://www.onvif.org/ver10/schema}SearchState", + "type_name": "SearchState", + "definition": { + "kind": "simpleType", + "name": "SearchState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Queued", + "description": "The search is queued and not yet started." + }, + { + "value": "Searching", + "description": "The search is underway and not yet completed." + }, + { + "value": "Completed", + "description": "The search has been completed and no new results will be found." + }, + { + "value": "Unknown", + "description": "The state of the search is unknown. (This is not a valid response from GetSearchState.)" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "EndSearch", + "port_type": "SearchPort", + "description": "EndSearch stops and ongoing search session, causing any blocking result request to return and the SearchToken to become invalid. If the search was interrupted before completion, the point in time that the search had reached shall be returned. If the search had not yet begun, the StartPoint shall be returned. If the search was completed the original EndPoint supplied by the Find operation shall be returned. When issuing EndSearch on a FindRecordings request the EndPoint is undefined and shall not be used since the FindRecordings request doesn't have StartPoint/EndPoint. This operation is mandatory to support for a device implementing the recording search service.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}EndSearchRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}EndSearch", + "schema": { + "name": "EndSearch", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The search session to end." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Ends an ongoing search session, freeing any resources." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}EndSearchResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}EndSearchResponse", + "schema": { + "name": "EndSearchResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Endpoint", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The point of time the search had reached when it was ended. It is equal to the EndPoint specified in Find-operation if the search was completed." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "FindMetadata", + "port_type": "SearchPort", + "description": "FindMetadata starts a search session, looking for metadata in the scope (See 20.2.4) that matches the search filter defined in the request. Results from the search are acquired using the GetMetadataSearchResults request, specifying the search token returned from this request. The device shall continue searching until one of the following occurs: The entire time range from StartPoint to EndPoint has been searched through. The total number of matches has been found, defined by the MaxMatches parameter. The session has been ended by a client EndSession request. The session has been ended because KeepAliveTime since the last request related to this session has expired. This operation is mandatory to support if the MetaDataSearch capability is set to true in the SearchCapabilities structure return by the GetCapabilities command in the Device service.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}FindMetadataRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}FindMetadata", + "schema": { + "name": "FindMetadata", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StartPoint", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The point of time where the search will start." + }, + { + "name": "EndPoint", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The point of time where the search will stop. This can be a time before the StartPoint, in which case the search is performed backwards in time." + }, + { + "name": "Scope", + "type": "{http://www.onvif.org/ver10/schema}SearchScope", + "type_name": "SearchScope", + "definition": { + "kind": "complexType", + "name": "SearchScope", + "description": "A structure for defining a limited scope when searching in recorded data.", + "fields": [ + { + "name": "IncludedSources", + "type": "{http://www.onvif.org/ver10/schema}SourceReference", + "type_name": "SourceReference", + "definition": { + "kind": "complexType", + "name": "SourceReference", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "default": "http://www.onvif.org/ver10/schema/Receiver" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of sources that are included in the scope. If this list is included, only data from one of these sources shall be searched." + }, + { + "name": "IncludedRecordings", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of recordings that are included in the scope. If this list is included, only data from one of these recordings shall be searched." + }, + { + "name": "RecordingInformationFilter", + "type": "{http://www.onvif.org/ver10/schema}XPathExpression", + "type_name": "XPathExpression", + "definition": { + "kind": "simpleType", + "name": "XPathExpression", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An xpath expression used to specify what recordings to search. Only those recordings with an RecordingInformation structure that matches the filter shall be searched." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SearchScopeExtension", + "type_name": "SearchScopeExtension", + "definition": { + "kind": "complexType", + "name": "SearchScopeExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Extension point" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MetadataFilter", + "type": "{http://www.onvif.org/ver10/schema}MetadataFilter", + "type_name": "MetadataFilter", + "definition": { + "kind": "complexType", + "name": "MetadataFilter", + "fields": [ + { + "name": "MetadataStreamFilter", + "type": "{http://www.onvif.org/ver10/schema}XPathExpression", + "type_name": "XPathExpression", + "definition": { + "kind": "simpleType", + "name": "XPathExpression", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "MaxMatches", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The search will be completed after this many matches. If not specified, the search will continue until reaching the endpoint or until the session expires." + }, + { + "name": "KeepAliveTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time the search session will be kept alive after responding to this and subsequent requests. A device shall support at least values up to ten seconds." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Starts a search session and specifies the search parameters." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}FindMetadataResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}FindMetadataResponse", + "schema": { + "name": "FindMetadataResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique reference to the search session created by this request." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "GetMetadataSearchResults", + "port_type": "SearchPort", + "description": "GetMetadataSearchResults acquires the results from a recording search session previously initiated by a FindMetadata operation. The response shall not include results already returned in previous requests for the same session. If MaxResults is specified, the response shall not contain more than MaxResults results. GetMetadataSearchResults shall block until: MaxResults results are available for the response if MaxResults is specified. MinResults results are available for the response if MinResults is specified. WaitTime has expired. Search is completed or stopped. This operation is mandatory to support if the MetaDataSearch capability is set to true in the SearchCapabilities structure return by the GetCapabilities command in the Device service.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetMetadataSearchResultsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetMetadataSearchResults", + "schema": { + "name": "GetMetadataSearchResults", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The search session to get results from." + }, + { + "name": "MinResults", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The minimum number of results to return in one response." + }, + { + "name": "MaxResults", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The maximum number of results to return in one response." + }, + { + "name": "WaitTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The maximum time before responding to the request, even if the MinResults parameter is not fulfilled." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Gets results from a particular search session." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetMetadataSearchResultsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetMetadataSearchResultsResponse", + "schema": { + "name": "GetMetadataSearchResultsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ResultList", + "type": "{http://www.onvif.org/ver10/schema}FindMetadataResultList", + "type_name": "FindMetadataResultList", + "definition": { + "kind": "complexType", + "name": "FindMetadataResultList", + "fields": [ + { + "name": "SearchState", + "type": "{http://www.onvif.org/ver10/schema}SearchState", + "type_name": "SearchState", + "definition": { + "kind": "simpleType", + "name": "SearchState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Queued", + "description": "The search is queued and not yet started." + }, + { + "value": "Searching", + "description": "The search is underway and not yet completed." + }, + { + "value": "Completed", + "description": "The search has been completed and no new results will be found." + }, + { + "value": "Unknown", + "description": "The state of the search is unknown. (This is not a valid response from GetSearchState.)" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed." + }, + { + "name": "Result", + "type": "{http://www.onvif.org/ver10/schema}FindMetadataResult", + "type_name": "FindMetadataResult", + "definition": { + "kind": "complexType", + "name": "FindMetadataResult", + "fields": [ + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the recording containing the metadata." + }, + { + "name": "TrackToken", + "type": "{http://www.onvif.org/ver10/schema}TrackReference", + "type_name": "TrackReference", + "definition": { + "kind": "simpleType", + "name": "TrackReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the metadata track containing the matching metadata." + }, + { + "name": "Time", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The point in time when the matching metadata occurs in the metadata track." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A FindMetadataResult structure for each found set of Metadata matching the search." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "SearchImageByNL", + "port_type": "SearchPort", + "description": "Starts a natural language search session and specifies the search parameters.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}SearchImageByNLRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}SearchImageByNLRequest", + "schema": { + "name": "SearchImageByNLRequest", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StartPoint", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Start time for the search." + }, + { + "name": "EndPoint", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The point of time where the search will stop. If EndPoint is omitted, the search will continue up to the latest recorded data available on the device." + }, + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token for the recording to search." + }, + { + "name": "Text", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Natural language description for the search (e.g., \"person with red hat\")." + }, + { + "name": "Similarity", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "It represents the similarity between two vectors, which is used to measure the similarity of the directions of the vectors. The closer the value is to 1, the higher the similarity; the closer the value is to 0, the lower the similarity." + }, + { + "name": "MaxMatches", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of matches to return in the response." + }, + { + "name": "KeepAliveTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time the search session will be kept alive after responding to this and subsequent requests." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Starts a search session and specifies the search parameters." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}SearchImageByNLResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}SearchImageByNLResponse", + "schema": { + "name": "SearchImageByNLResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique reference to the search session created by this request." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "GetNLSearchResults", + "port_type": "SearchPort", + "description": "Gets results from a natural language search session.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetNLSearchResultsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetNLSearchResultsRequest", + "schema": { + "name": "GetNLSearchResultsRequest", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The search session to get results from." + }, + { + "name": "MinResults", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The minimum number of results to return in one response." + }, + { + "name": "MaxResults", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The maximum number of results to return in one response." + }, + { + "name": "WaitTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The maximum time before responding to the request, even if the MinResults parameter is not fulfilled." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Gets results from a particular search session." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetNLSearchResultsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetNLSearchResultsResponse", + "schema": { + "name": "GetNLSearchResultsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ResultList", + "type": "{http://www.onvif.org/ver10/schema}FindNLSearchResultList", + "type_name": "FindNLSearchResultList", + "definition": { + "kind": "complexType", + "name": "FindNLSearchResultList", + "fields": [ + { + "name": "SearchState", + "type": "{http://www.onvif.org/ver10/schema}SearchState", + "type_name": "SearchState", + "definition": { + "kind": "simpleType", + "name": "SearchState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Queued", + "description": "The search is queued and not yet started." + }, + { + "value": "Searching", + "description": "The search is underway and not yet completed." + }, + { + "value": "Completed", + "description": "The search has been completed and no new results will be found." + }, + { + "value": "Unknown", + "description": "The state of the search is unknown. (This is not a valid response from GetSearchState.)" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed." + }, + { + "name": "Result", + "type": "{http://www.onvif.org/ver10/schema}FindNLSearchResult", + "type_name": "FindNLSearchResult", + "definition": { + "kind": "complexType", + "name": "FindNLSearchResult", + "fields": [ + { + "name": "ObjectUUID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Object unique identifier." + }, + { + "name": "TargetImageURI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The URI of the detected target object image stored in the Target Image repository (LocalStorage format)." + }, + { + "name": "Time", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time when the target was found. Users can use this as a reference point to search records that occurred before and after this specific time point." + }, + { + "name": "Similarity", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "It represents the similarity between two vectors, which is used to measure the similarity of the directions of the vectors. The closer the value is to 1, the higher the similarity; the closer the value is to 0, the lower the similarity." + }, + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The recording where this result was found." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A FindNLSearchResult structure for each found set of image matching the search." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "SearchImageByImage", + "port_type": "SearchPort", + "description": "Starts an image-based search session and specifies the search parameters.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}SearchImageByImageRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}SearchImageByImageRequest", + "schema": { + "name": "SearchImageByImageRequest", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "StartPoint", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Start time for the search." + }, + { + "name": "EndPoint", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The point of time where the search will stop. If EndPoint is omitted, the search will continue up to the latest recorded data available on the device." + }, + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token for the recording to search." + }, + { + "name": "TargetImageURI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Exactly one of TargetImageURI or TargetImageData shall be provided. If both are provided, the device shall use TargetImageData. If neither is provided, the device shall respond with an InvalidArgVal fault. The URI of the detected target object image stored in the Target Image repository (LocalStorage format)." + }, + { + "name": "TargetImageData", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Exactly one of TargetImageURI or TargetImageData shall be provided. If both are provided, the device shall use TargetImageData. If neither is provided, the device shall respond with an InvalidArgVal fault. Base64-encoded target object image used for visual search." + }, + { + "name": "MaxMatches", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum number of matches to return in the response." + }, + { + "name": "KeepAliveTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time the search session will be kept alive after responding to this and subsequent requests." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Starts a search session and specifies the search parameters." + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}SearchImageByImageResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}SearchImageByImageResponse", + "schema": { + "name": "SearchImageByImageResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A unique reference to the search session created by this request." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + }, + { + "name": "GetImageSearchResults", + "port_type": "SearchPort", + "description": "Gets results from an image-based search session.", + "input": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetImageSearchResultsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetImageSearchResultsRequest", + "schema": { + "name": "GetImageSearchResultsRequest", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SearchToken", + "type": "{http://www.onvif.org/ver10/schema}JobToken", + "type_name": "JobToken", + "definition": { + "kind": "simpleType", + "name": "JobToken", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The search session to get results from." + }, + { + "name": "MinResults", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The minimum number of results to return in one response." + }, + { + "name": "MaxResults", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The maximum number of results to return in one response." + }, + { + "name": "WaitTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The maximum time before responding to the request, even if the MinResults parameter is not fulfilled." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/search/wsdl}GetImageSearchResultsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/search/wsdl}GetImageSearchResultsResponse", + "schema": { + "name": "GetImageSearchResultsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ResultList", + "type": "{http://www.onvif.org/ver10/schema}FindObjectImageResultList", + "type_name": "FindObjectImageResultList", + "definition": { + "kind": "complexType", + "name": "FindObjectImageResultList", + "fields": [ + { + "name": "SearchState", + "type": "{http://www.onvif.org/ver10/schema}SearchState", + "type_name": "SearchState", + "definition": { + "kind": "simpleType", + "name": "SearchState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Queued", + "description": "The search is queued and not yet started." + }, + { + "value": "Searching", + "description": "The search is underway and not yet completed." + }, + { + "value": "Completed", + "description": "The search has been completed and no new results will be found." + }, + { + "value": "Unknown", + "description": "The state of the search is unknown. (This is not a valid response from GetSearchState.)" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed." + }, + { + "name": "Result", + "type": "{http://www.onvif.org/ver10/schema}FindObjectImageResult", + "type_name": "FindObjectImageResult", + "definition": { + "kind": "complexType", + "name": "FindObjectImageResult", + "fields": [ + { + "name": "ObjectUUID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Object unique identifier." + }, + { + "name": "TargetImageURI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The URI of the detected target object image stored in the Target Image repository (LocalStorage format)." + }, + { + "name": "Time", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The time when the target was found. Users can use this as a reference point to search records that occurred before and after this specific time point." + }, + { + "name": "Similarity", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "It represents the similarity between two vectors, which is used to measure the similarity of the directions of the vectors. The closer the value is to 1, the higher the similarity; the closer the value is to 0, the lower the similarity." + }, + { + "name": "RecordingToken", + "type": "{http://www.onvif.org/ver10/schema}RecordingReference", + "type_name": "RecordingReference", + "definition": { + "kind": "simpleType", + "name": "RecordingReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The recording where this result was found." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A FindObjectImageResult structure for each found set of image matching the search." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "SearchBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/thermal/wsdl/thermal.json b/docs/generated/wsdl/ver10/thermal/wsdl/thermal.json new file mode 100644 index 00000000..91c99e4e --- /dev/null +++ b/docs/generated/wsdl/ver10/thermal/wsdl/thermal.json @@ -0,0 +1,1944 @@ +{ + "source": "ver10/thermal/wsdl/thermal.wsdl", + "target_namespace": "http://www.onvif.org/ver10/thermal/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "ThermalPort", + "description": "Returns the capabilities of the thermal service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Radiometry", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not radiometric thermal measurements are supported by the thermal device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities of the thermal service are returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ThermalBinding" + }, + { + "name": "GetConfigurationOptions", + "port_type": "ThermalPort", + "description": "Gets the valid ranges for the Thermal parameters that have device specific ranges. This command is mandatory for all devices implementing the Thermal service. The command shall return all supported parameters and their ranges, such that these can be applied to the SetConfiguration command.", + "input": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}GetConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}GetConfigurationOptions", + "schema": { + "name": "GetConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the VideoSource for which the Thermal Configuration Options are requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}GetConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}GetConfigurationOptionsResponse", + "schema": { + "name": "GetConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationOptions", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}ConfigurationOptions", + "type_name": "ConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "ConfigurationOptions", + "fields": [ + { + "name": "ColorPalette", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}ColorPalette", + "type_name": "ColorPalette", + "definition": { + "kind": "complexType", + "name": "ColorPalette", + "description": "Describes a Color Palette element.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable Color Palette name." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of this Color Palette." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Indicates Color Palette Type. Use tth:ColorPaletteType. \n\t\t\t\t\t\tUsed for multi-language support and display." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of Color Palettes available for the requested Thermal VideoSource." + }, + { + "name": "NUCTable", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}NUCTable", + "type_name": "NUCTable", + "definition": { + "kind": "complexType", + "name": "NUCTable", + "description": "Type describing a NUC Table element.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User reabable name for the Non-Uniformity Correction (NUC) Table." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of this NUC Table." + }, + { + "use": "optional", + "name": "LowTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Low Temperature limit for application of NUC Table, in Kelvin." + }, + { + "use": "optional", + "name": "HighTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "High Temperature limit for application of NUC Table, in Kelvin." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of Non-Uniformity Correction (NUC) Tables available for the requested Thermal VideoSource." + }, + { + "name": "CoolerOptions", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}CoolerOptions", + "type_name": "CoolerOptions", + "definition": { + "kind": "complexType", + "name": "CoolerOptions", + "description": "Describes valid ranges for the thermal device cooler settings. \n\t\t\t\t\tOnly applicable to cooled thermal devices.", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the Device allows cooler status to be changed from running (Enabled) to stopped (Disabled), and viceversa." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Specifies Cooler Options for cooled thermal devices." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Valid ranges for the Thermal configuration parameters that are categorized as device specific." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ThermalBinding" + }, + { + "name": "GetConfiguration", + "port_type": "ThermalPort", + "description": "Gets the Thermal Configuration for the requested VideoSource.", + "input": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}GetConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}GetConfiguration", + "schema": { + "name": "GetConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the VideoSource for which the Thermal Settings are requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}GetConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}GetConfigurationResponse", + "schema": { + "name": "GetConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}Configuration", + "type_name": "Configuration", + "definition": { + "kind": "complexType", + "name": "Configuration", + "fields": [ + { + "name": "ColorPalette", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}ColorPalette", + "type_name": "ColorPalette", + "definition": { + "kind": "complexType", + "name": "ColorPalette", + "description": "Describes a Color Palette element.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable Color Palette name." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of this Color Palette." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Indicates Color Palette Type. Use tth:ColorPaletteType. \n\t\t\t\t\t\tUsed for multi-language support and display." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current Color Palette in use by the Thermal Device." + }, + { + "name": "Polarity", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}Polarity", + "type_name": "Polarity", + "definition": { + "kind": "simpleType", + "name": "Polarity", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "WhiteHot" + }, + { + "value": "BlackHot" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Polarity configuration of the Thermal Device." + }, + { + "name": "NUCTable", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}NUCTable", + "type_name": "NUCTable", + "definition": { + "kind": "complexType", + "name": "NUCTable", + "description": "Type describing a NUC Table element.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User reabable name for the Non-Uniformity Correction (NUC) Table." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of this NUC Table." + }, + { + "use": "optional", + "name": "LowTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Low Temperature limit for application of NUC Table, in Kelvin." + }, + { + "use": "optional", + "name": "HighTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "High Temperature limit for application of NUC Table, in Kelvin." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Current Non-Uniformity Correction (NUC) Table in use by the Thermal Device." + }, + { + "name": "Cooler", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}Cooler", + "type_name": "Cooler", + "definition": { + "kind": "complexType", + "name": "Cooler", + "description": "Type describing the Cooler settings.", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the Cooler is enabled (running) or not." + }, + { + "name": "RunTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Number of hours the Cooler has been running (unit: hours). Read-only." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Cooler settings of the Thermal Device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Thermal Settings for the VideoSource that was requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ThermalBinding" + }, + { + "name": "GetConfigurations", + "port_type": "ThermalPort", + "description": "Gets the Thermal Configuration for all thermal VideoSources of the Device.", + "input": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}GetConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}GetConfigurations", + "schema": { + "name": "GetConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}GetConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}GetConfigurationsResponse", + "schema": { + "name": "GetConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}Configurations", + "type_name": "Configurations", + "definition": { + "kind": "complexType", + "name": "Configurations", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}Configuration", + "type_name": "Configuration", + "definition": { + "kind": "complexType", + "name": "Configuration", + "fields": [ + { + "name": "ColorPalette", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}ColorPalette", + "type_name": "ColorPalette", + "definition": { + "kind": "complexType", + "name": "ColorPalette", + "description": "Describes a Color Palette element.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable Color Palette name." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of this Color Palette." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Indicates Color Palette Type. Use tth:ColorPaletteType. \n\t\t\t\t\t\tUsed for multi-language support and display." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current Color Palette in use by the Thermal Device." + }, + { + "name": "Polarity", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}Polarity", + "type_name": "Polarity", + "definition": { + "kind": "simpleType", + "name": "Polarity", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "WhiteHot" + }, + { + "value": "BlackHot" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Polarity configuration of the Thermal Device." + }, + { + "name": "NUCTable", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}NUCTable", + "type_name": "NUCTable", + "definition": { + "kind": "complexType", + "name": "NUCTable", + "description": "Type describing a NUC Table element.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User reabable name for the Non-Uniformity Correction (NUC) Table." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of this NUC Table." + }, + { + "use": "optional", + "name": "LowTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Low Temperature limit for application of NUC Table, in Kelvin." + }, + { + "use": "optional", + "name": "HighTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "High Temperature limit for application of NUC Table, in Kelvin." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Current Non-Uniformity Correction (NUC) Table in use by the Thermal Device." + }, + { + "name": "Cooler", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}Cooler", + "type_name": "Cooler", + "definition": { + "kind": "complexType", + "name": "Cooler", + "description": "Type describing the Cooler settings.", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the Cooler is enabled (running) or not." + }, + { + "name": "RunTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Number of hours the Cooler has been running (unit: hours). Read-only." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Cooler settings of the Thermal Device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current Thermal Settings for the VideoSource." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Reference token to the thermal VideoSource." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of thermal VideoSource configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ThermalBinding" + }, + { + "name": "SetConfiguration", + "port_type": "ThermalPort", + "description": "Sets the Thermal Configuration for the requested VideoSource.", + "input": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}SetConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}SetConfiguration", + "schema": { + "name": "SetConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the VideoSource for which the Thermal Settings are configured." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}Configuration", + "type_name": "Configuration", + "definition": { + "kind": "complexType", + "name": "Configuration", + "fields": [ + { + "name": "ColorPalette", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}ColorPalette", + "type_name": "ColorPalette", + "definition": { + "kind": "complexType", + "name": "ColorPalette", + "description": "Describes a Color Palette element.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable Color Palette name." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of this Color Palette." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Indicates Color Palette Type. Use tth:ColorPaletteType. \n\t\t\t\t\t\tUsed for multi-language support and display." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Current Color Palette in use by the Thermal Device." + }, + { + "name": "Polarity", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}Polarity", + "type_name": "Polarity", + "definition": { + "kind": "simpleType", + "name": "Polarity", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "WhiteHot" + }, + { + "value": "BlackHot" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Polarity configuration of the Thermal Device." + }, + { + "name": "NUCTable", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}NUCTable", + "type_name": "NUCTable", + "definition": { + "kind": "complexType", + "name": "NUCTable", + "description": "Type describing a NUC Table element.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User reabable name for the Non-Uniformity Correction (NUC) Table." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of this NUC Table." + }, + { + "use": "optional", + "name": "LowTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Low Temperature limit for application of NUC Table, in Kelvin." + }, + { + "use": "optional", + "name": "HighTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "High Temperature limit for application of NUC Table, in Kelvin." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Current Non-Uniformity Correction (NUC) Table in use by the Thermal Device." + }, + { + "name": "Cooler", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}Cooler", + "type_name": "Cooler", + "definition": { + "kind": "complexType", + "name": "Cooler", + "description": "Type describing the Cooler settings.", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the Cooler is enabled (running) or not." + }, + { + "name": "RunTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Number of hours the Cooler has been running (unit: hours). Read-only." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Cooler settings of the Thermal Device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Thermal Settings to be configured." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}SetConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}SetConfigurationResponse", + "schema": { + "name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ThermalBinding" + }, + { + "name": "GetRadiometryConfigurationOptions", + "port_type": "ThermalPort", + "description": "Gets the valid ranges for the Radiometry parameters that have device specific ranges. The command shall return all supported parameters and their ranges, such that these can be applied to the SetRadiometryConfiguration command.", + "input": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}GetRadiometryConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}GetRadiometryConfigurationOptions", + "schema": { + "name": "GetRadiometryConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the VideoSource for which the Thermal Radiometry Options are requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}GetRadiometryConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}GetRadiometryConfigurationOptionsResponse", + "schema": { + "name": "GetRadiometryConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationOptions", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}RadiometryConfigurationOptions", + "type_name": "RadiometryConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "RadiometryConfigurationOptions", + "fields": [ + { + "name": "RadiometryGlobalParameterOptions", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}RadiometryGlobalParameterOptions", + "type_name": "RadiometryGlobalParameterOptions", + "definition": { + "kind": "complexType", + "name": "RadiometryGlobalParameterOptions", + "description": "Describes valid ranges for the different radiometry parameters required for accurate temperature calculation.", + "fields": [ + { + "name": "ReflectedAmbientTemperature", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of temperature values, in Kelvin." + }, + { + "name": "Emissivity", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of emissivity values for the objects to measure." + }, + { + "name": "DistanceToObject", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of distance between camera and object for a valid temperature reading, in meters." + }, + { + "name": "RelativeHumidity", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of relative humidity values, in percentage." + }, + { + "name": "AtmosphericTemperature", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of temperature values, in Kelvin." + }, + { + "name": "AtmosphericTransmittance", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of atmospheric transmittance values." + }, + { + "name": "ExtOpticsTemperature", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of temperature values, in Kelvin." + }, + { + "name": "ExtOpticsTransmittance", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of external optics transmittance." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Specifies valid ranges and options for the global radiometry parameters used as default parameter values\n\t\t\t\t\t\t\t\tfor temperature measurement modules (spots and boxes)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Valid ranges for the Thermal Radiometry parameters that are categorized as device specific." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ThermalBinding" + }, + { + "name": "GetRadiometryConfiguration", + "port_type": "ThermalPort", + "description": "Gets the Radiometry Configuration for the requested VideoSource.", + "input": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}GetRadiometryConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}GetRadiometryConfiguration", + "schema": { + "name": "GetRadiometryConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the VideoSource for which the Radiometry Configuration is requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}GetRadiometryConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}GetRadiometryConfigurationResponse", + "schema": { + "name": "GetRadiometryConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}RadiometryConfiguration", + "type_name": "RadiometryConfiguration", + "definition": { + "kind": "complexType", + "name": "RadiometryConfiguration", + "fields": [ + { + "name": "RadiometryGlobalParameters", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}RadiometryGlobalParameters", + "type_name": "RadiometryGlobalParameters", + "definition": { + "kind": "complexType", + "name": "RadiometryGlobalParameters", + "description": "Holds default values that will be used in measurement modules when local parameters are not specified for the module (these are still required for valid temperature calculations). \n\t\t\t\t\t\tHaving ReflectedAmbientTemperature, Emissivity and DistanceToObject as mandatory ensures minimum parameters are available to obtain valid temperature values.", + "fields": [ + { + "name": "ReflectedAmbientTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reflected Ambient Temperature for the environment in which the thermal device and the object being measured is located." + }, + { + "name": "Emissivity", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Emissivity of the surface of the object on which temperature is being measured." + }, + { + "name": "DistanceToObject", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Distance from the thermal device to the measured object." + }, + { + "name": "RelativeHumidity", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Relative Humidity in the environment in which the measurement is located." + }, + { + "name": "AtmosphericTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Temperature of the atmosphere between the thermal device and the object being measured." + }, + { + "name": "AtmosphericTransmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Transmittance value for the atmosphere between the thermal device and the object being measured." + }, + { + "name": "ExtOpticsTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Temperature of the optics elements between the thermal device and the object being measured." + }, + { + "name": "ExtOpticsTransmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Transmittance value for the optics elements between the thermal device and the object being measured." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Global Parameters for Radiometry Measurements. Shall exist if Radiometry Capability is reported, \n\t\t\t\t\t\t\t\tand Global Parameters are supported by the device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Radiometry Configuration for the VideoSource that was requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ThermalBinding" + }, + { + "name": "SetRadiometryConfiguration", + "port_type": "ThermalPort", + "description": "Sets the Radiometry Configuration for the requested VideoSource.", + "input": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}SetRadiometryConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}SetRadiometryConfiguration", + "schema": { + "name": "SetRadiometryConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the VideoSource for which the Radiometry settings are configured." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}RadiometryConfiguration", + "type_name": "RadiometryConfiguration", + "definition": { + "kind": "complexType", + "name": "RadiometryConfiguration", + "fields": [ + { + "name": "RadiometryGlobalParameters", + "type": "{http://www.onvif.org/ver10/thermal/wsdl}RadiometryGlobalParameters", + "type_name": "RadiometryGlobalParameters", + "definition": { + "kind": "complexType", + "name": "RadiometryGlobalParameters", + "description": "Holds default values that will be used in measurement modules when local parameters are not specified for the module (these are still required for valid temperature calculations). \n\t\t\t\t\t\tHaving ReflectedAmbientTemperature, Emissivity and DistanceToObject as mandatory ensures minimum parameters are available to obtain valid temperature values.", + "fields": [ + { + "name": "ReflectedAmbientTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reflected Ambient Temperature for the environment in which the thermal device and the object being measured is located." + }, + { + "name": "Emissivity", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Emissivity of the surface of the object on which temperature is being measured." + }, + { + "name": "DistanceToObject", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Distance from the thermal device to the measured object." + }, + { + "name": "RelativeHumidity", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Relative Humidity in the environment in which the measurement is located." + }, + { + "name": "AtmosphericTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Temperature of the atmosphere between the thermal device and the object being measured." + }, + { + "name": "AtmosphericTransmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Transmittance value for the atmosphere between the thermal device and the object being measured." + }, + { + "name": "ExtOpticsTemperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Temperature of the optics elements between the thermal device and the object being measured." + }, + { + "name": "ExtOpticsTransmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Transmittance value for the optics elements between the thermal device and the object being measured." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Global Parameters for Radiometry Measurements. Shall exist if Radiometry Capability is reported, \n\t\t\t\t\t\t\t\tand Global Parameters are supported by the device." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Radiometry settings to be configured." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/thermal/wsdl}SetRadiometryConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/thermal/wsdl}SetRadiometryConfigurationResponse", + "schema": { + "name": "SetRadiometryConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ThermalBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver10/uplink/wsdl/uplink.json b/docs/generated/wsdl/ver10/uplink/wsdl/uplink.json new file mode 100644 index 00000000..26a99312 --- /dev/null +++ b/docs/generated/wsdl/ver10/uplink/wsdl/uplink.json @@ -0,0 +1,459 @@ +{ + "source": "ver10/uplink/wsdl/uplink.wsdl", + "target_namespace": "http://www.onvif.org/ver10/uplink/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "UplinkPort", + "description": "Returns the capabilities of the uplink service.", + "input": { + "message": "{http://www.onvif.org/ver10/uplink/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/uplink/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/uplink/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/uplink/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver10/uplink/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "MaxUplinks", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of uplink connections that can be configured." + }, + { + "use": "optional", + "name": "Protocols", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Protocols supported by the device. Defined values are 'https' for native h2c-reverse and 'wss' for h2c-reverse over WebSocket as defined by tup:Protocols." + }, + { + "use": "optional", + "name": "AuthorizationModes", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Supported authorization mode [mTLS AccessToken] as defined by tup:AuthorizationModes." + }, + { + "use": "optional", + "name": "StreamingOverUplink", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Signals support for media streaming over uplink." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the uplink service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "UplinkBinding" + }, + { + "name": "GetUplinks", + "port_type": "UplinkPort", + "description": "A device supporting uplinks shall support this command to retrieve the configured uplink configurations. The Status field shall signal whether a connection is Offline, Connecting or Online.", + "input": { + "message": "{http://www.onvif.org/ver10/uplink/wsdl}GetUplinksRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/uplink/wsdl}GetUplinks", + "schema": { + "name": "GetUplinks", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/uplink/wsdl}GetUplinksResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/uplink/wsdl}GetUplinksResponse", + "schema": { + "name": "GetUplinksResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/uplink/wsdl}Configuration", + "type_name": "Configuration", + "definition": { + "kind": "complexType", + "name": "Configuration", + "fields": [ + { + "name": "RemoteAddress", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Uniform resource locator by which the remote client can be reached." + }, + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "ID of the certificate to be used for client authentication." + }, + { + "name": "UserLevel", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of authorization levels and roles that will be used to restrict the commands that will be accepted through the uplink connection." + }, + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Current connection status (see tup:ConnectionStatus for possible values)." + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "CertPathValidationPolicyID used to validate the uplink server certificate. If not configured, server certificate validation \n\t\t\t\t\t\t\t\tbehavior is undefined and the device may either apply a vendor specific default validation policy or skip validation at all." + }, + { + "name": "AuthorizationServer", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "AuthorizationServer token referring to the server that provides access tokens to authorize with the uplink server." + }, + { + "name": "Error", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable error information (readonly)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of configured uplinks." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "UplinkBinding" + }, + { + "name": "SetUplink", + "port_type": "UplinkPort", + "description": "A device supporting uplinks shall support this command to add or modify an uplink configuration. The Status property of the UplinkConfiguration shall be ignored by the device. A device shall use the field RemoteAddress to decide whether to update an existing entry or create a new entry.", + "input": { + "message": "{http://www.onvif.org/ver10/uplink/wsdl}SetUplinkRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/uplink/wsdl}SetUplink", + "schema": { + "name": "SetUplink", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/uplink/wsdl}Configuration", + "type_name": "Configuration", + "definition": { + "kind": "complexType", + "name": "Configuration", + "fields": [ + { + "name": "RemoteAddress", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Uniform resource locator by which the remote client can be reached." + }, + { + "name": "CertificateID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "ID of the certificate to be used for client authentication." + }, + { + "name": "UserLevel", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of authorization levels and roles that will be used to restrict the commands that will be accepted through the uplink connection." + }, + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Current connection status (see tup:ConnectionStatus for possible values)." + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "CertPathValidationPolicyID used to validate the uplink server certificate. If not configured, server certificate validation \n\t\t\t\t\t\t\t\tbehavior is undefined and the device may either apply a vendor specific default validation policy or skip validation at all." + }, + { + "name": "AuthorizationServer", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "AuthorizationServer token referring to the server that provides access tokens to authorize with the uplink server." + }, + { + "name": "Error", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable error information (readonly)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configuration to be added or modified." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/uplink/wsdl}SetUplinkResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/uplink/wsdl}SetUplinkResponse", + "schema": { + "name": "SetUplinkResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "UplinkBinding" + }, + { + "name": "DeleteUplink", + "port_type": "UplinkPort", + "description": "A device supporting uplinks shall support this command to remove an uplink configuration.", + "input": { + "message": "{http://www.onvif.org/ver10/uplink/wsdl}DeleteUplinkRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/uplink/wsdl}DeleteUplink", + "schema": { + "name": "DeleteUplink", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RemoteAddress", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Uniform resource locator of the configuration to be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver10/uplink/wsdl}DeleteUplinkResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver10/uplink/wsdl}DeleteUplinkResponse", + "schema": { + "name": "DeleteUplinkResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "UplinkBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver20/analytics/wsdl/analytics.json b/docs/generated/wsdl/ver20/analytics/wsdl/analytics.json new file mode 100644 index 00000000..e5f87f4b --- /dev/null +++ b/docs/generated/wsdl/ver20/analytics/wsdl/analytics.json @@ -0,0 +1,10958 @@ +{ + "source": "ver20/analytics/wsdl/analytics.wsdl", + "target_namespace": "http://www.onvif.org/ver20/analytics/wsdl", + "operations": [ + { + "name": "GetSupportedRules", + "port_type": "RuleEnginePort", + "description": "List all rules that are supported by the given VideoAnalyticsConfiguration.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetSupportedRulesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetSupportedRules", + "schema": { + "name": "GetSupportedRules", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "References an existing Video Analytics configuration. The list of available tokens can be obtained\n\t\t\t\t\t\t\t\t\tvia the Media service GetVideoAnalyticsConfigurations method." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetSupportedRulesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetSupportedRulesResponse", + "schema": { + "name": "GetSupportedRulesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SupportedRules", + "type": "{http://www.onvif.org/ver10/schema}SupportedRules", + "type_name": "SupportedRules", + "definition": { + "kind": "complexType", + "name": "SupportedRules", + "fields": [ + { + "name": "RuleContentSchemaLocation", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Lists the location of all schemas that are referenced in the rules." + }, + { + "name": "RuleDescription", + "type": "{http://www.onvif.org/ver10/schema}ConfigDescription", + "type_name": "ConfigDescription", + "definition": { + "kind": "complexType", + "name": "ConfigDescription", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescription", + "type_name": "ItemListDescription", + "definition": { + "kind": "complexType", + "name": "ItemListDescription", + "description": "Describes a list of items. Each item in the list shall have a unique name.\n\t\t\tThe list is designed as linear structure without optional or unbounded elements.\n\t\t\tUse ElementItems only when complex structures are inevitable.", + "fields": [ + { + "name": "SimpleItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...)." + }, + { + "name": "ElementItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a complex type. The Type must reference a defined type." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescriptionExtension", + "type_name": "ItemListDescriptionExtension", + "definition": { + "kind": "complexType", + "name": "ItemListDescriptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List describing the configuration parameters. The names of the parameters must be unique. If possible SimpleItems\n\t\t\t\t\t\tshould be used to transport the information to ease parsing of dynamically defined messages by a client\n\t\t\t\t\t\tapplication." + }, + { + "name": "Messages", + "definition": { + "kind": "complexType", + "base": "{http://www.onvif.org/ver10/schema}MessageDescription", + "base_definition": { + "kind": "complexType", + "name": "MessageDescription", + "fields": [ + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescription", + "type_name": "ItemListDescription", + "definition": { + "kind": "complexType", + "name": "ItemListDescription", + "description": "Describes a list of items. Each item in the list shall have a unique name.\n\t\t\tThe list is designed as linear structure without optional or unbounded elements.\n\t\t\tUse ElementItems only when complex structures are inevitable.", + "fields": [ + { + "name": "SimpleItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...)." + }, + { + "name": "ElementItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a complex type. The Type must reference a defined type." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescriptionExtension", + "type_name": "ItemListDescriptionExtension", + "definition": { + "kind": "complexType", + "name": "ItemListDescriptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Set of tokens producing this message. The list may only contain SimpleItemDescription items.\n\t\t\t\t\tThe set of tokens identify the component within the WS-Endpoint, which is responsible for the producing the message.
\n\t\t\t\t\tFor analytics events the token set shall include the VideoSourceConfigurationToken, the VideoAnalyticsConfigurationToken\n\t\t\t\t\tand the name of the analytics module or rule." + }, + { + "name": "Key", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescription", + "type_name": "ItemListDescription", + "definition": { + "kind": "complexType", + "name": "ItemListDescription", + "description": "Describes a list of items. Each item in the list shall have a unique name.\n\t\t\tThe list is designed as linear structure without optional or unbounded elements.\n\t\t\tUse ElementItems only when complex structures are inevitable.", + "fields": [ + { + "name": "SimpleItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...)." + }, + { + "name": "ElementItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a complex type. The Type must reference a defined type." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescriptionExtension", + "type_name": "ItemListDescriptionExtension", + "definition": { + "kind": "complexType", + "name": "ItemListDescriptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describes optional message payload parameters that may be used as key. E.g. object IDs of tracked objects are conveyed as key." + }, + { + "name": "Data", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescription", + "type_name": "ItemListDescription", + "definition": { + "kind": "complexType", + "name": "ItemListDescription", + "description": "Describes a list of items. Each item in the list shall have a unique name.\n\t\t\tThe list is designed as linear structure without optional or unbounded elements.\n\t\t\tUse ElementItems only when complex structures are inevitable.", + "fields": [ + { + "name": "SimpleItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...)." + }, + { + "name": "ElementItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a complex type. The Type must reference a defined type." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescriptionExtension", + "type_name": "ItemListDescriptionExtension", + "definition": { + "kind": "complexType", + "name": "ItemListDescriptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describes the payload of the message." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MessageDescriptionExtension", + "type_name": "MessageDescriptionExtension", + "definition": { + "kind": "complexType", + "name": "MessageDescriptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "IsProperty", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Must be set to true when the described Message relates to a property. An alternative term of \"property\" is a \"state\" in contrast to a pure event, which contains relevant information for only a single point in time.
Default is false." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "ParentTopic", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The topic of the message. For historical reason the element is named ParentTopic, but the full topic is expected." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The analytics modules and rule engine produce Events, which must be listed within the Analytics Module Description. In order to do so\n\t\t\t\t\t\tthe structure of the Message is defined and consists of three groups: Source, Key, and Data. It is recommended to use SimpleItemDescriptions wherever applicable.\n\t\t\t\t\t\tThe name of all Items must be unique within all Items contained in any group of this Message.\n\t\t\t\t\t\tDepending on the component multiple parameters or none may be needed to identify the component uniquely." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ConfigDescriptionExtension", + "type_name": "ConfigDescriptionExtension", + "definition": { + "kind": "complexType", + "name": "ConfigDescriptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Name attribute (e.g. \"tt::LineDetector\") uniquely identifies the type of rule, not a type definition in a schema." + }, + { + "use": "optional", + "name": "fixed", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "The fixed attribute signals that it is not allowed to add or remove this type of configuration." + }, + { + "use": "optional", + "name": "maxInstances", + "type": "{http://www.w3.org/2001/XMLSchema}integer", + "description": "The maxInstances attribute signals the maximum number of instances per configuration." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of rules supported by the Video Analytics configuration.." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SupportedRulesExtension", + "type_name": "SupportedRulesExtension", + "definition": { + "kind": "complexType", + "name": "SupportedRulesExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of concurrent instances." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RuleEngineBinding" + }, + { + "name": "CreateRules", + "port_type": "RuleEnginePort", + "description": "Add one or more rules to an existing VideoAnalyticsConfiguration. The available supported types can be retrieved via GetSupportedRules, where the Name of the supported rule correspond to the type of an rule instance. Pass unique module names which can be later used as reference. The Parameters of the rules must match those of the corresponding description. Although this method is mandatory a device implementation must not support adding rules. Instead it can provide a fixed set of predefined configurations via the media service function GetCompatibleVideoAnalyticsConfigurations.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}CreateRulesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}CreateRules", + "schema": { + "name": "CreateRules", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to an existing VideoAnalyticsConfiguration." + }, + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}CreateRulesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}CreateRulesResponse", + "schema": { + "name": "CreateRulesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RuleEngineBinding" + }, + { + "name": "DeleteRules", + "port_type": "RuleEnginePort", + "description": "Remove one or more rules from a VideoAnalyticsConfiguration.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}DeleteRulesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}DeleteRules", + "schema": { + "name": "DeleteRules", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to an existing VideoAnalyticsConfiguration." + }, + { + "name": "RuleName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "References the specific rule to be deleted (e.g. \"MyLineDetector\")." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}DeleteRulesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}DeleteRulesResponse", + "schema": { + "name": "DeleteRulesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RuleEngineBinding" + }, + { + "name": "GetRules", + "port_type": "RuleEnginePort", + "description": "List the currently assigned set of rules of a VideoAnalyticsConfiguration.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetRulesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetRules", + "schema": { + "name": "GetRules", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to an existing VideoAnalyticsConfiguration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetRulesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetRulesResponse", + "schema": { + "name": "GetRulesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RuleEngineBinding" + }, + { + "name": "GetRuleOptions", + "port_type": "RuleEnginePort", + "description": "Return the options for the supported rules that specify an Option attribute.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetRuleOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetRuleOptions", + "schema": { + "name": "GetRuleOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RuleType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Reference to an SupportedRule Type returned from GetSupportedRules." + }, + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to an existing analytics configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetRuleOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetRuleOptionsResponse", + "schema": { + "name": "GetRuleOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "RuleOptions", + "type": "{http://www.onvif.org/ver20/analytics/wsdl}ConfigOptions", + "type_name": "ConfigOptions", + "definition": { + "kind": "complexType", + "name": "ConfigOptions", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "RuleType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The RuleType the ConfigOptions applies to if the Name attribute is ambiguous." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The Name of the SimpleItemDescription/ElementItemDescription\n\t\t\t\t\t\t\tthe ConfigOptions applies to." + }, + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "Type of the Rule Options represented by a unique QName. \n\t\t\t\t\t\t\tThe Type defines the element contained in this structure.\n\t\t\t\t\t\t\tThis attribute is deprecated since its value must be identical to the embedded element." + }, + { + "use": "optional", + "name": "AnalyticsModule", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "Optional name of the analytics module this constraint applies to. This option is only necessary in cases where different constraints for elements with the same Name exist." + }, + { + "use": "optional", + "name": "minOccurs", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Minimal number of occurrences. Defaults to one." + }, + { + "use": "optional", + "name": "maxOccurs", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of occurrences. Defaults to one." + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A device shall provide respective ConfigOptions.RuleType for each RuleOption if the request does not specify RuleType. The response Options shall not contain any AnalyticsModule attribute." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RuleEngineBinding" + }, + { + "name": "ModifyRules", + "port_type": "RuleEnginePort", + "description": "Modify one or more rules of a VideoAnalyticsConfiguration. The rules are referenced by their names.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}ModifyRulesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}ModifyRules", + "schema": { + "name": "ModifyRules", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to an existing VideoAnalyticsConfiguration." + }, + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}ModifyRulesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}ModifyRulesResponse", + "schema": { + "name": "ModifyRulesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "RuleEngineBinding" + }, + { + "name": "GetServiceCapabilities", + "port_type": "AnalyticsEnginePort", + "description": "Returns the capabilities of the analytics service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver20/analytics/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "RuleSupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication that the device supports the rules interface and the rules syntax." + }, + { + "use": "optional", + "name": "AnalyticsModuleSupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication that the device supports the scene analytics module interface." + }, + { + "use": "optional", + "name": "CellBasedSceneDescriptionSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication that the device produces the cell based scene description" + }, + { + "use": "optional", + "name": "RuleOptionsSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication that the device supports the GetRuleOptions operation on the rules interface" + }, + { + "use": "optional", + "name": "AnalyticsModuleOptionsSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication that the device supports the GetAnalyticsModuleOptions operation on the analytics interface" + }, + { + "use": "optional", + "name": "SupportedMetadata", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication that the device supports the GetSupportedMetadata operation." + }, + { + "use": "optional", + "name": "ImageSendingType", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Indication what kinds of method that the device support for sending image, acceptable values are defined in tt:ImageSendingType." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the analytics service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsEngineBinding" + }, + { + "name": "GetSupportedAnalyticsModules", + "port_type": "AnalyticsEnginePort", + "description": "List all analytics modules that are supported by the given VideoAnalyticsConfiguration.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetSupportedAnalyticsModulesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetSupportedAnalyticsModules", + "schema": { + "name": "GetSupportedAnalyticsModules", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to an existing VideoAnalyticsConfiguration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetSupportedAnalyticsModulesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetSupportedAnalyticsModulesResponse", + "schema": { + "name": "GetSupportedAnalyticsModulesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "SupportedAnalyticsModules", + "type": "{http://www.onvif.org/ver10/schema}SupportedAnalyticsModules", + "type_name": "SupportedAnalyticsModules", + "definition": { + "kind": "complexType", + "name": "SupportedAnalyticsModules", + "fields": [ + { + "name": "AnalyticsModuleContentSchemaLocation", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "It optionally contains a list of URLs that provide the location of schema files.\n\t\t\t\t\tThese schema files describe the types and elements used in the analytics module descriptions.\n\t\t\t\t\tAnalytics module descriptions that reference types or elements imported from any ONVIF defined schema files\n\t\t\t\t\tneed not explicitly list those schema files." + }, + { + "name": "AnalyticsModuleDescription", + "type": "{http://www.onvif.org/ver10/schema}ConfigDescription", + "type_name": "ConfigDescription", + "definition": { + "kind": "complexType", + "name": "ConfigDescription", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescription", + "type_name": "ItemListDescription", + "definition": { + "kind": "complexType", + "name": "ItemListDescription", + "description": "Describes a list of items. Each item in the list shall have a unique name.\n\t\t\tThe list is designed as linear structure without optional or unbounded elements.\n\t\t\tUse ElementItems only when complex structures are inevitable.", + "fields": [ + { + "name": "SimpleItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...)." + }, + { + "name": "ElementItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a complex type. The Type must reference a defined type." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescriptionExtension", + "type_name": "ItemListDescriptionExtension", + "definition": { + "kind": "complexType", + "name": "ItemListDescriptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List describing the configuration parameters. The names of the parameters must be unique. If possible SimpleItems\n\t\t\t\t\t\tshould be used to transport the information to ease parsing of dynamically defined messages by a client\n\t\t\t\t\t\tapplication." + }, + { + "name": "Messages", + "definition": { + "kind": "complexType", + "base": "{http://www.onvif.org/ver10/schema}MessageDescription", + "base_definition": { + "kind": "complexType", + "name": "MessageDescription", + "fields": [ + { + "name": "Source", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescription", + "type_name": "ItemListDescription", + "definition": { + "kind": "complexType", + "name": "ItemListDescription", + "description": "Describes a list of items. Each item in the list shall have a unique name.\n\t\t\tThe list is designed as linear structure without optional or unbounded elements.\n\t\t\tUse ElementItems only when complex structures are inevitable.", + "fields": [ + { + "name": "SimpleItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...)." + }, + { + "name": "ElementItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a complex type. The Type must reference a defined type." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescriptionExtension", + "type_name": "ItemListDescriptionExtension", + "definition": { + "kind": "complexType", + "name": "ItemListDescriptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Set of tokens producing this message. The list may only contain SimpleItemDescription items.\n\t\t\t\t\tThe set of tokens identify the component within the WS-Endpoint, which is responsible for the producing the message.
\n\t\t\t\t\tFor analytics events the token set shall include the VideoSourceConfigurationToken, the VideoAnalyticsConfigurationToken\n\t\t\t\t\tand the name of the analytics module or rule." + }, + { + "name": "Key", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescription", + "type_name": "ItemListDescription", + "definition": { + "kind": "complexType", + "name": "ItemListDescription", + "description": "Describes a list of items. Each item in the list shall have a unique name.\n\t\t\tThe list is designed as linear structure without optional or unbounded elements.\n\t\t\tUse ElementItems only when complex structures are inevitable.", + "fields": [ + { + "name": "SimpleItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...)." + }, + { + "name": "ElementItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a complex type. The Type must reference a defined type." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescriptionExtension", + "type_name": "ItemListDescriptionExtension", + "definition": { + "kind": "complexType", + "name": "ItemListDescriptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describes optional message payload parameters that may be used as key. E.g. object IDs of tracked objects are conveyed as key." + }, + { + "name": "Data", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescription", + "type_name": "ItemListDescription", + "definition": { + "kind": "complexType", + "name": "ItemListDescription", + "description": "Describes a list of items. Each item in the list shall have a unique name.\n\t\t\tThe list is designed as linear structure without optional or unbounded elements.\n\t\t\tUse ElementItems only when complex structures are inevitable.", + "fields": [ + { + "name": "SimpleItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...)." + }, + { + "name": "ElementItemDescription", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Description of a complex type. The Type must reference a defined type." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListDescriptionExtension", + "type_name": "ItemListDescriptionExtension", + "definition": { + "kind": "complexType", + "name": "ItemListDescriptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName" + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name. Must be unique within a list." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The type of the item. The Type must reference a defined type." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describes the payload of the message." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MessageDescriptionExtension", + "type_name": "MessageDescriptionExtension", + "definition": { + "kind": "complexType", + "name": "MessageDescriptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "IsProperty", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Must be set to true when the described Message relates to a property. An alternative term of \"property\" is a \"state\" in contrast to a pure event, which contains relevant information for only a single point in time.
Default is false." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [ + { + "name": "ParentTopic", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The topic of the message. For historical reason the element is named ParentTopic, but the full topic is expected." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The analytics modules and rule engine produce Events, which must be listed within the Analytics Module Description. In order to do so\n\t\t\t\t\t\tthe structure of the Message is defined and consists of three groups: Source, Key, and Data. It is recommended to use SimpleItemDescriptions wherever applicable.\n\t\t\t\t\t\tThe name of all Items must be unique within all Items contained in any group of this Message.\n\t\t\t\t\t\tDepending on the component multiple parameters or none may be needed to identify the component uniquely." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ConfigDescriptionExtension", + "type_name": "ConfigDescriptionExtension", + "definition": { + "kind": "complexType", + "name": "ConfigDescriptionExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Name attribute (e.g. \"tt::LineDetector\") uniquely identifies the type of rule, not a type definition in a schema." + }, + { + "use": "optional", + "name": "fixed", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "The fixed attribute signals that it is not allowed to add or remove this type of configuration." + }, + { + "use": "optional", + "name": "maxInstances", + "type": "{http://www.w3.org/2001/XMLSchema}integer", + "description": "The maxInstances attribute signals the maximum number of instances per configuration." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}SupportedAnalyticsModulesExtension", + "type_name": "SupportedAnalyticsModulesExtension", + "definition": { + "kind": "complexType", + "name": "SupportedAnalyticsModulesExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Limit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of concurrent instances." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsEngineBinding" + }, + { + "name": "GetAnalyticsModuleOptions", + "port_type": "AnalyticsEnginePort", + "description": "Return the options for the supported analytics modules that specify an Option attribute.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetAnalyticsModuleOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetAnalyticsModuleOptions", + "schema": { + "name": "GetAnalyticsModuleOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Reference to an SupportedAnalyticsModule Type returned from GetSupportedAnalyticsModules." + }, + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to an existing AnalyticsConfiguration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetAnalyticsModuleOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetAnalyticsModuleOptionsResponse", + "schema": { + "name": "GetAnalyticsModuleOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver20/analytics/wsdl}ConfigOptions", + "type_name": "ConfigOptions", + "definition": { + "kind": "complexType", + "name": "ConfigOptions", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "RuleType", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The RuleType the ConfigOptions applies to if the Name attribute is ambiguous." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The Name of the SimpleItemDescription/ElementItemDescription\n\t\t\t\t\t\t\tthe ConfigOptions applies to." + }, + { + "use": "optional", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "Type of the Rule Options represented by a unique QName. \n\t\t\t\t\t\t\tThe Type defines the element contained in this structure.\n\t\t\t\t\t\t\tThis attribute is deprecated since its value must be identical to the embedded element." + }, + { + "use": "optional", + "name": "AnalyticsModule", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "Optional name of the analytics module this constraint applies to. This option is only necessary in cases where different constraints for elements with the same Name exist." + }, + { + "use": "optional", + "name": "minOccurs", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Minimal number of occurrences. Defaults to one." + }, + { + "use": "optional", + "name": "maxOccurs", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of occurrences. Defaults to one." + } + ], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of options for the specified analytics module. The response Options shall not contain any RuleType attribute." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsEngineBinding" + }, + { + "name": "CreateAnalyticsModules", + "port_type": "AnalyticsEnginePort", + "description": "Add one or more analytics modules to an existing VideoAnalyticsConfiguration. The available supported types can be retrieved via GetSupportedAnalyticsModules, where the Name of the supported AnalyticsModules correspond to the type of an AnalyticsModule instance. Pass unique module names which can be later used as reference. The Parameters of the analytics module must match those of the corresponding AnalyticsModuleDescription. Although this method is mandatory a device implementation may not support adding modules. Instead it can provide a fixed set of predefined configurations via the media service functions GetCompatibleVideoAnalyticsConfigurations and GetAnalyticsConfigurations. The device shall ensure that a corresponding analytics engine starts operation when a client subscribes directly or indirectly for events produced by the analytics or rule engine or when a client requests the corresponding scene description stream. An analytics module must be attached to a Video source using the media profiles before it can be used. In case differing analytics configurations are attached to the same profile it is undefined which of the analytics module configuration becomes active if no stream is activated or multiple streams with different profiles are activated at the same time.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}CreateAnalyticsModulesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}CreateAnalyticsModules", + "schema": { + "name": "CreateAnalyticsModules", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to an existing VideoAnalyticsConfiguration." + }, + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}CreateAnalyticsModulesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}CreateAnalyticsModulesResponse", + "schema": { + "name": "CreateAnalyticsModulesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsEngineBinding" + }, + { + "name": "DeleteAnalyticsModules", + "port_type": "AnalyticsEnginePort", + "description": "Remove one or more analytics modules from a VideoAnalyticsConfiguration referenced by their names.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}DeleteAnalyticsModulesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}DeleteAnalyticsModules", + "schema": { + "name": "DeleteAnalyticsModules", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to an existing Video Analytics configuration." + }, + { + "name": "AnalyticsModuleName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Name of the AnalyticsModule to be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}DeleteAnalyticsModulesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}DeleteAnalyticsModulesResponse", + "schema": { + "name": "DeleteAnalyticsModulesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsEngineBinding" + }, + { + "name": "GetAnalyticsModules", + "port_type": "AnalyticsEnginePort", + "description": "List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetAnalyticsModulesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetAnalyticsModules", + "schema": { + "name": "GetAnalyticsModules", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to an existing VideoAnalyticsConfiguration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetAnalyticsModulesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetAnalyticsModulesResponse", + "schema": { + "name": "GetAnalyticsModulesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsEngineBinding" + }, + { + "name": "ModifyAnalyticsModules", + "port_type": "AnalyticsEnginePort", + "description": "Modify the settings of one or more analytics modules of a VideoAnalyticsConfiguration. The modules are referenced by their names. It is allowed to pass only a subset to be modified.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}ModifyAnalyticsModulesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}ModifyAnalyticsModules", + "schema": { + "name": "ModifyAnalyticsModules", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to an existing VideoAnalyticsConfiguration." + }, + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}ModifyAnalyticsModulesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}ModifyAnalyticsModulesResponse", + "schema": { + "name": "ModifyAnalyticsModulesResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsEngineBinding" + }, + { + "name": "GetSupportedMetadata", + "port_type": "AnalyticsEnginePort", + "description": "This method provides a computer readable description of the metadata that the selected analytics modules can generate. The type parameter allows to select a single analytics module. By default the output shall relate to all analytics modules that exist in the device. The response shall provide a sample XML frame. The sample frame shall include all potentially generated elements by the selected analytics modules. Note that this e.g. does not need to include all possible class type enumerations.", + "input": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetSupportedMetadataRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetSupportedMetadata", + "schema": { + "name": "GetSupportedMetadata", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "type_name": "QName", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional reference to an AnalyticsModule Type returned from GetSupportedAnalyticsModules." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/analytics/wsdl}GetSupportedMetadataResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/analytics/wsdl}GetSupportedMetadataResponse", + "schema": { + "name": "GetSupportedMetadataResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver20/analytics/wsdl}MetadataInfo", + "type_name": "MetadataInfo", + "definition": { + "kind": "complexType", + "name": "MetadataInfo", + "fields": [ + { + "name": "SampleFrame", + "type": "{http://www.onvif.org/ver10/schema}Frame", + "type_name": "Frame", + "definition": { + "kind": "complexType", + "name": "Frame", + "fields": [ + { + "name": "PTZStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZStatus", + "type_name": "PTZStatus", + "definition": { + "kind": "complexType", + "name": "PTZStatus", + "fields": [ + { + "name": "Position", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the absolute position of the PTZ unit together with the Space references. The default absolute spaces of the corresponding PTZ configuration MUST be referenced within the Position element." + }, + { + "name": "MoveStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZMoveStatus", + "type_name": "PTZMoveStatus", + "definition": { + "kind": "complexType", + "name": "PTZMoveStatus", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}MoveStatus", + "type_name": "MoveStatus", + "definition": { + "kind": "simpleType", + "name": "MoveStatus", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IDLE" + }, + { + "value": "MOVING" + }, + { + "value": "UNKNOWN" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}MoveStatus", + "type_name": "MoveStatus", + "definition": { + "kind": "simpleType", + "name": "MoveStatus", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IDLE" + }, + { + "value": "MOVING" + }, + { + "value": "UNKNOWN" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the Pan/Tilt/Zoom device unit is currently moving, idle or in an unknown state." + }, + { + "name": "Error", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "States a current PTZ error." + }, + { + "name": "UtcTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the UTC time when this status was generated." + }, + { + "name": "FieldOfView", + "type": "{http://www.onvif.org/ver10/schema}FieldOfView", + "type_name": "FieldOfView", + "definition": { + "kind": "complexType", + "name": "FieldOfView", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "hfov", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Horizontal field-of-view in degrees." + }, + { + "use": "required", + "name": "vfov", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Vertical field-of-view in degrees." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "States the current field of view of the video stream." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Transformation", + "type": "{http://www.onvif.org/ver10/schema}Transformation", + "type_name": "Transformation", + "definition": { + "kind": "complexType", + "name": "Transformation", + "fields": [ + { + "name": "Translate", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Scale", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}TransformationExtension", + "type_name": "TransformationExtension", + "definition": { + "kind": "complexType", + "name": "TransformationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Object", + "type": "{http://www.onvif.org/ver10/schema}Object", + "type_name": "Object", + "definition": { + "kind": "complexType", + "name": "Object", + "base": "{http://www.onvif.org/ver10/schema}ObjectId", + "base_definition": { + "kind": "complexType", + "name": "ObjectId", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "ObjectId", + "type": "{http://www.w3.org/2001/XMLSchema}integer" + }, + { + "use": "optional", + "name": "UUID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Object unique identifier." + } + ] + }, + "fields": [ + { + "name": "Appearance", + "type": "{http://www.onvif.org/ver10/schema}Appearance", + "type_name": "Appearance", + "definition": { + "kind": "complexType", + "name": "Appearance", + "fields": [ + { + "name": "Transformation", + "type": "{http://www.onvif.org/ver10/schema}Transformation", + "type_name": "Transformation", + "definition": { + "kind": "complexType", + "name": "Transformation", + "fields": [ + { + "name": "Translate", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Scale", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}TransformationExtension", + "type_name": "TransformationExtension", + "definition": { + "kind": "complexType", + "name": "TransformationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Shape", + "type": "{http://www.onvif.org/ver10/schema}ShapeDescriptor", + "type_name": "ShapeDescriptor", + "definition": { + "kind": "complexType", + "name": "ShapeDescriptor", + "fields": [ + { + "name": "BoundingBox", + "type": "{http://www.onvif.org/ver10/schema}Rectangle", + "type_name": "Rectangle", + "definition": { + "kind": "complexType", + "name": "Rectangle", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "bottom", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "top", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "right", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "left", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "CenterOfGravity", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Polygon", + "type": "{http://www.onvif.org/ver10/schema}Polygon", + "type_name": "Polygon", + "definition": { + "kind": "complexType", + "name": "Polygon", + "fields": [ + { + "name": "Point", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 3, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ShapeDescriptorExtension", + "type_name": "ShapeDescriptorExtension", + "definition": { + "kind": "complexType", + "name": "ShapeDescriptorExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Class", + "type": "{http://www.onvif.org/ver10/schema}ClassDescriptor", + "type_name": "ClassDescriptor", + "definition": { + "kind": "complexType", + "name": "ClassDescriptor", + "fields": [ + { + "name": "ClassCandidate", + "type": "{http://www.onvif.org/ver10/schema}ClassCandidate", + "type_name": "ClassCandidate", + "definition": { + "kind": "complexType", + "name": "ClassCandidate", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}ClassType", + "type_name": "ClassType", + "definition": { + "kind": "simpleType", + "name": "ClassType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Animal" + }, + { + "value": "Face" + }, + { + "value": "Human" + }, + { + "value": "Vehical" + }, + { + "value": "Other" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ClassDescriptorExtension", + "type_name": "ClassDescriptorExtension", + "definition": { + "kind": "complexType", + "name": "ClassDescriptorExtension", + "fields": [ + { + "name": "OtherTypes", + "type": "{http://www.onvif.org/ver10/schema}OtherType", + "type_name": "OtherType", + "definition": { + "kind": "complexType", + "name": "OtherType", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Object Class Type" + }, + { + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A likelihood/probability that the corresponding object belongs to this class. The sum of the likelihoods shall NOT exceed 1." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}StringLikelihood", + "type_name": "StringLikelihood", + "definition": { + "kind": "complexType", + "name": "StringLikelihood", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "For well-defined values, see tt:ObjectType. Other type definitions like tt:VehicleType may be applied as well." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AppearanceExtension", + "type_name": "AppearanceExtension", + "definition": { + "kind": "complexType", + "name": "AppearanceExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "GeoLocation", + "type": "{http://www.onvif.org/ver10/schema}GeoLocation", + "type_name": "GeoLocation", + "definition": { + "kind": "complexType", + "name": "GeoLocation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "lon", + "type": "{http://www.w3.org/2001/XMLSchema}double", + "description": "East west location as angle." + }, + { + "use": "optional", + "name": "lat", + "type": "{http://www.w3.org/2001/XMLSchema}double", + "description": "North south location as angle." + }, + { + "use": "optional", + "name": "elevation", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Height in meters above sea level." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "VehicleInfo", + "type": "{http://www.onvif.org/ver10/schema}VehicleInfo", + "type_name": "VehicleInfo", + "definition": { + "kind": "complexType", + "name": "VehicleInfo", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}StringLikelihood", + "type_name": "StringLikelihood", + "definition": { + "kind": "complexType", + "name": "StringLikelihood", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Brand", + "type": "{http://www.onvif.org/ver10/schema}StringLikelihood", + "type_name": "StringLikelihood", + "definition": { + "kind": "complexType", + "name": "StringLikelihood", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Model", + "type": "{http://www.onvif.org/ver10/schema}StringLikelihood", + "type_name": "StringLikelihood", + "definition": { + "kind": "complexType", + "name": "StringLikelihood", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "LicensePlateInfo", + "type": "{http://www.onvif.org/ver10/schema}LicensePlateInfo", + "type_name": "LicensePlateInfo", + "definition": { + "kind": "complexType", + "name": "LicensePlateInfo", + "fields": [ + { + "name": "PlateNumber", + "type": "{http://www.onvif.org/ver10/schema}StringLikelihood", + "type_name": "StringLikelihood", + "definition": { + "kind": "complexType", + "name": "StringLikelihood", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A string of vehicle license plate number." + }, + { + "name": "PlateType", + "type": "{http://www.onvif.org/ver10/schema}StringLikelihood", + "type_name": "StringLikelihood", + "definition": { + "kind": "complexType", + "name": "StringLikelihood", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A description of the vehicle license plate, e.g., \"Normal\", \"Police\", \"Diplomat\"" + }, + { + "name": "CountryCode", + "type": "{http://www.onvif.org/ver10/schema}StringLikelihood", + "type_name": "StringLikelihood", + "definition": { + "kind": "complexType", + "name": "StringLikelihood", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the country of the license plate, in order to avoid the same license plate number." + }, + { + "name": "IssuingEntity", + "type": "{http://www.onvif.org/ver10/schema}StringLikelihood", + "type_name": "StringLikelihood", + "definition": { + "kind": "complexType", + "name": "StringLikelihood", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "State, province or authority that issues the license plate." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the background color of the license plate in case of vehicle objects." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "HumanFace", + "type": "{http://www.onvif.org/ver20/analytics/humanface}HumanFace", + "type_name": "HumanFace", + "definition": { + "kind": "complexType", + "name": "HumanFace", + "fields": [ + { + "name": "Age", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the age of the face." + }, + { + "name": "Gender", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the gender of the face, acceptable values are defined in fc:Gender." + }, + { + "name": "Temperature", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the temperature of the face, in Kelvin." + }, + { + "name": "Complexion", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the complexion of the face, acceptable values are defined in fc:Complexion." + }, + { + "name": "FacialShape", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the facial shape, acceptable values are defined in fc:FacialShape." + }, + { + "name": "Hair", + "type": "{http://www.onvif.org/ver20/analytics/humanface}Hair", + "type_name": "Hair", + "definition": { + "kind": "complexType", + "name": "Hair", + "fields": [ + { + "name": "Length", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the length of the Hair, acceptable values are defined in fc:Length. Short usually means that the end of the hair doesn’t exceed the shoulder. \n\t\t\t\t\t\t\t\tMedium usually means that the end of the hair is parallel with the shoulder. Long usually means that the end of the hair exceeds the chest." + }, + { + "name": "Style", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the style of the Hair, acceptable values are defined in fc:HairStyle." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the color of the Hair." + }, + { + "name": "Bangs", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the bangs of the Hair." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the hair of the face." + }, + { + "name": "Eyebrow", + "type": "{http://www.onvif.org/ver20/analytics/humanface}Eyebrow", + "type_name": "Eyebrow", + "definition": { + "kind": "complexType", + "name": "Eyebrow", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the shape of the eyebrow. Short usually means that the width of the eyebrow is shorter than the length of the eye.\n\t\t\t\tLong usually means that the width of eyebrow is equal to or longer than the length of eye. Acceptable values are defined in fc:EyebrowWidth." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the eyebrow." + }, + { + "name": "Space", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the space of two eyebrows, acceptable values are defined in fc:EyebrowSpace." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the eyebrow of the face." + }, + { + "name": "Eye", + "type": "{http://www.onvif.org/ver20/analytics/humanface}Eye", + "type_name": "Eye", + "definition": { + "kind": "complexType", + "name": "Eye", + "fields": [ + { + "name": "Shape", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the shape of the eye, acceptable values are defined in fc:EyeShape." + }, + { + "name": "Eyelid", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the eyelid of the eye, acceptable values are defined in fc:Eyelid." + }, + { + "name": "Eyeball", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the eyeball of the eye, acceptable values are defined in fc:Eyeball." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the eye of the face." + }, + { + "name": "Ear", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Ear of the face. For definitions see fc:EarShape." + }, + { + "name": "Nose", + "type": "{http://www.onvif.org/ver20/analytics/humanface}Nose", + "type_name": "Nose", + "definition": { + "kind": "complexType", + "name": "Nose", + "fields": [ + { + "name": "Length", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the length of the nose, acceptable values are defined in fc:NoseLength. \n\t\t\t\tLong usually means that the length of the nose is longer than 1/3 of the length of the face.\n\t\t\t\tshort usually means that the length of the nose is shorter than 1/3 of the length of the face." + }, + { + "name": "NoseBridge", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the bridge of the nose, acceptable values are defined in fc:NoseBridge." + }, + { + "name": "NoseWing", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the wing of the nose, acceptable values are defined in fc:NoseWing." + }, + { + "name": "NoseEnd", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the end of the nose, acceptable values are defined in fc:NoseEnd." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the nose of the face." + }, + { + "name": "FacialHair", + "type": "{http://www.onvif.org/ver20/analytics/humanface}FacialHair", + "type_name": "FacialHair", + "definition": { + "kind": "complexType", + "name": "FacialHair", + "fields": [ + { + "name": "Mustache", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if there is a mustache on the face." + }, + { + "name": "Beard", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if there is a beard on the face." + }, + { + "name": "Sideburn", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if there are sideburns on the face." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the facial hair of the face." + }, + { + "name": "Lip", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the lip of the face, acceptable values are defined in fc:Lip." + }, + { + "name": "Chin", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Chin of the face, acceptable values are defined in fc:Chin." + }, + { + "name": "Expression", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the expression on the face, acceptable values are defined in fc:Expression." + }, + { + "name": "PoseAngle", + "type": "{http://www.onvif.org/ver20/analytics/humanface}PoseAngle", + "type_name": "PoseAngle", + "definition": { + "kind": "complexType", + "name": "PoseAngle", + "fields": [ + { + "name": "PoseAngles", + "type": "{http://www.onvif.org/ver10/schema}GeoOrientation", + "type_name": "GeoOrientation", + "definition": { + "kind": "complexType", + "name": "GeoOrientation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "roll", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the x axis." + }, + { + "use": "optional", + "name": "pitch", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the y axis." + }, + { + "use": "optional", + "name": "yaw", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the z axis." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the pose angle of the face." + }, + { + "name": "Uncertainty", + "type": "{http://www.onvif.org/ver10/schema}GeoOrientation", + "type_name": "GeoOrientation", + "definition": { + "kind": "complexType", + "name": "GeoOrientation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "roll", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the x axis." + }, + { + "use": "optional", + "name": "pitch", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the y axis." + }, + { + "use": "optional", + "name": "yaw", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the z axis." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the expected degree of uncertainty of the pose angle yaw, pitch, and roll." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the pose angle of the face." + }, + { + "name": "Accessory", + "type": "{http://www.onvif.org/ver20/analytics/humanface}Accessory", + "type_name": "Accessory", + "definition": { + "kind": "complexType", + "name": "Accessory", + "fields": [ + { + "name": "Opticals", + "type": "{http://www.onvif.org/ver20/analytics/humanface}AccessoryDescription", + "type_name": "AccessoryDescription", + "definition": { + "kind": "complexType", + "name": "AccessoryDescription", + "fields": [ + { + "name": "Wear", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears an accessory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the accessory." + }, + { + "name": "Subtype", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional subtype of the accessory. For definitions refer enumerations starting with \n\t\t\t\t\t\tthe accessory name followed by 'Type' like fc:HatType or fc:HelmetType." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears opticals." + }, + { + "name": "Hat", + "type": "{http://www.onvif.org/ver20/analytics/humanface}AccessoryDescription", + "type_name": "AccessoryDescription", + "definition": { + "kind": "complexType", + "name": "AccessoryDescription", + "fields": [ + { + "name": "Wear", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears an accessory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the accessory." + }, + { + "name": "Subtype", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional subtype of the accessory. For definitions refer enumerations starting with \n\t\t\t\t\t\tthe accessory name followed by 'Type' like fc:HatType or fc:HelmetType." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears a hat." + }, + { + "name": "Mask", + "type": "{http://www.onvif.org/ver20/analytics/humanface}AccessoryDescription", + "type_name": "AccessoryDescription", + "definition": { + "kind": "complexType", + "name": "AccessoryDescription", + "fields": [ + { + "name": "Wear", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears an accessory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the accessory." + }, + { + "name": "Subtype", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional subtype of the accessory. For definitions refer enumerations starting with \n\t\t\t\t\t\tthe accessory name followed by 'Type' like fc:HatType or fc:HelmetType." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears a mask." + }, + { + "name": "Hijab", + "type": "{http://www.onvif.org/ver20/analytics/humanface}AccessoryDescription", + "type_name": "AccessoryDescription", + "definition": { + "kind": "complexType", + "name": "AccessoryDescription", + "fields": [ + { + "name": "Wear", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears an accessory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the accessory." + }, + { + "name": "Subtype", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional subtype of the accessory. For definitions refer enumerations starting with \n\t\t\t\t\t\tthe accessory name followed by 'Type' like fc:HatType or fc:HelmetType." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears a hijab." + }, + { + "name": "Helmet", + "type": "{http://www.onvif.org/ver20/analytics/humanface}AccessoryDescription", + "type_name": "AccessoryDescription", + "definition": { + "kind": "complexType", + "name": "AccessoryDescription", + "fields": [ + { + "name": "Wear", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears an accessory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the accessory." + }, + { + "name": "Subtype", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional subtype of the accessory. For definitions refer enumerations starting with \n\t\t\t\t\t\tthe accessory name followed by 'Type' like fc:HatType or fc:HelmetType." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears a helmet." + }, + { + "name": "Kerchief", + "type": "{http://www.onvif.org/ver20/analytics/humanface}AccessoryDescription", + "type_name": "AccessoryDescription", + "definition": { + "kind": "complexType", + "name": "AccessoryDescription", + "fields": [ + { + "name": "Wear", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears an accessory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the accessory." + }, + { + "name": "Subtype", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional subtype of the accessory. For definitions refer enumerations starting with \n\t\t\t\t\t\tthe accessory name followed by 'Type' like fc:HatType or fc:HelmetType." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears a kerchief." + }, + { + "name": "RightEyePatch", + "type": "{http://www.onvif.org/ver20/analytics/humanface}AccessoryDescription", + "type_name": "AccessoryDescription", + "definition": { + "kind": "complexType", + "name": "AccessoryDescription", + "fields": [ + { + "name": "Wear", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears an accessory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the accessory." + }, + { + "name": "Subtype", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional subtype of the accessory. For definitions refer enumerations starting with \n\t\t\t\t\t\tthe accessory name followed by 'Type' like fc:HatType or fc:HelmetType." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if there is a patch on the right eye." + }, + { + "name": "LeftEyePatch", + "type": "{http://www.onvif.org/ver20/analytics/humanface}AccessoryDescription", + "type_name": "AccessoryDescription", + "definition": { + "kind": "complexType", + "name": "AccessoryDescription", + "fields": [ + { + "name": "Wear", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the object wears an accessory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the accessory." + }, + { + "name": "Subtype", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional subtype of the accessory. For definitions refer enumerations starting with \n\t\t\t\t\t\tthe accessory name followed by 'Type' like fc:HatType or fc:HelmetType." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if there is a patch on the left eye." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Accessory of the face." + }, + { + "name": "AdditionalFeatures", + "type": "{http://www.onvif.org/ver20/analytics/humanface}AdditionalFeatures", + "type_name": "AdditionalFeatures", + "definition": { + "kind": "complexType", + "name": "AdditionalFeatures", + "fields": [ + { + "name": "Scar", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if there is a scar on the face." + }, + { + "name": "Mole", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if there is a mole on the face." + }, + { + "name": "Tattoo", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if there is a tattoo on the face." + }, + { + "name": "Freckles", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe freckles on the face, acceptable values are defined in fc:FrecklesType." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the other features, e.g. scars, moles, etc. of the face." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "HumanBody", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}HumanBody", + "type_name": "HumanBody", + "definition": { + "kind": "complexType", + "name": "HumanBody", + "fields": [ + { + "name": "BodyMetric", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}BodyMetric", + "type_name": "BodyMetric", + "definition": { + "kind": "complexType", + "name": "BodyMetric", + "fields": [ + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the stature of the body, the unit is centimeters." + }, + { + "name": "BodyShape", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the shape of the body, acceptable values are defined in bd:BodyShape." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the body metric of the body." + }, + { + "name": "Clothing", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Clothing", + "type_name": "Clothing", + "definition": { + "kind": "complexType", + "name": "Clothing", + "fields": [ + { + "name": "Scarf", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Scarf", + "type_name": "Scarf", + "definition": { + "kind": "complexType", + "name": "Scarf", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the Scarf, acceptable values are defined in ColorDescriptor." + }, + { + "name": "Wear", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the body wears the Scarf." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Scarf of the body, acceptable values are defined in bd:Scarf." + }, + { + "name": "Gloves", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Gloves", + "type_name": "Gloves", + "definition": { + "kind": "complexType", + "name": "Gloves", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of Gloves, acceptable values are defined in tt:ColorDescriptor." + }, + { + "name": "Wear", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the body wears Gloves." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe Gloves of the body, acceptable values are defined in bd:Gloves." + }, + { + "name": "Tops", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Tops", + "type_name": "Tops", + "definition": { + "kind": "complexType", + "name": "Tops", + "fields": [ + { + "name": "Category", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Category of the Tops, acceptable values are defined in bd:TopsCategory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the Tops, acceptable values are defined in tt:ColorDescriptor." + }, + { + "name": "Grain", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Grain of the Tops, acceptable values are defined in bd:Grain." + }, + { + "name": "Style", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Style of the Tops, acceptable values are defined in bd:TopsStyle." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Tops of the body, acceptable values are defined in bd:Tops." + }, + { + "name": "Bottoms", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Bottoms", + "type_name": "Bottoms", + "definition": { + "kind": "complexType", + "name": "Bottoms", + "fields": [ + { + "name": "Category", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Category of the Bottoms, acceptable values are defined in bd:BottomsCategory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the Bottoms, acceptable values are defined in tt:ColorDescriptor." + }, + { + "name": "Grain", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Grain of the Bottoms, acceptable values are defined in bd:Grain." + }, + { + "name": "Style", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Style of the Bottoms, acceptable values are defined in bd:BottomsStyle." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Bottoms of the body, acceptable values are defined in bd:Bottoms." + }, + { + "name": "Shoes", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Shoes", + "type_name": "Shoes", + "definition": { + "kind": "complexType", + "name": "Shoes", + "fields": [ + { + "name": "Category", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Category of the Shoes, acceptable values are defined in bd:ShoesCategory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the Shoes, acceptable values are defined in tt:ColorDescriptor." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Shoes of the body, acceptable values are defined in bd:Shoes." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Clothing of the body." + }, + { + "name": "Belonging", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Belonging", + "type_name": "Belonging", + "definition": { + "kind": "complexType", + "name": "Belonging", + "fields": [ + { + "name": "Bag", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Bag", + "type_name": "Bag", + "definition": { + "kind": "complexType", + "name": "Bag", + "fields": [ + { + "name": "Category", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Category of the Bag, acceptable values are defined in bd:BagCategory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the Bag, acceptable values are defined in tt:ColorDescriptor." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Bag of the body, acceptable values are defined in bd:Bag" + }, + { + "name": "Umbrella", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Umbrella", + "type_name": "Umbrella", + "definition": { + "kind": "complexType", + "name": "Umbrella", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the Umbrella, acceptable values are defined in tt:ColorDescriptor." + }, + { + "name": "Open", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the body Opens the Umbrella." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Umbrella carried by the body, acceptable values are defined in bd:Umbrella." + }, + { + "name": "LiftSomething", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the body Lifts something." + }, + { + "name": "Box", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Box", + "type_name": "Box", + "definition": { + "kind": "complexType", + "name": "Box", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the Box, acceptable values are defined in tt:ColorDescriptor." + }, + { + "name": "Lug", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the body Lugs the Box." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Box lugged by the body, acceptable values are defined in bd:Box." + }, + { + "name": "Cart", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Cart", + "type_name": "Cart", + "definition": { + "kind": "complexType", + "name": "Cart", + "fields": [ + { + "name": "Category", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Category of the Cart, acceptable values are defined in bd:CartCategory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the Cart, acceptable values are defined in tt:ColorDescriptor." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Cart pushed by the body, acceptable values are defined in bd:Cart." + }, + { + "name": "Weapon", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the body carries the Weapon." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Deprecated set of belongings. Use Belongings." + }, + { + "name": "Behaviour", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Behaviour", + "type_name": "Behaviour", + "definition": { + "kind": "complexType", + "name": "Behaviour", + "fields": [ + { + "name": "Smoking", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Acceptable values are defined in bd:Smoking." + }, + { + "name": "UsingMobile", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Acceptable values are defined in bd:UsingMobile." + }, + { + "name": "Activity", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the activity of the body, acceptable values are defined in bd:HumanActivity." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Behaviour of the body." + }, + { + "name": "Belongings", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Belongings", + "type_name": "Belongings", + "definition": { + "kind": "complexType", + "name": "Belongings", + "fields": [ + { + "name": "Bag", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Bag", + "type_name": "Bag", + "definition": { + "kind": "complexType", + "name": "Bag", + "fields": [ + { + "name": "Category", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Category of the Bag, acceptable values are defined in bd:BagCategory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the Bag, acceptable values are defined in tt:ColorDescriptor." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Describes a bag the body is wearing." + }, + { + "name": "Umbrella", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Umbrella", + "type_name": "Umbrella", + "definition": { + "kind": "complexType", + "name": "Umbrella", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the Umbrella, acceptable values are defined in tt:ColorDescriptor." + }, + { + "name": "Open", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe if the body Opens the Umbrella." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describes an umbrella carried by the body." + }, + { + "name": "Cart", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Cart", + "type_name": "Cart", + "definition": { + "kind": "complexType", + "name": "Cart", + "fields": [ + { + "name": "Category", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Category of the Cart, acceptable values are defined in bd:CartCategory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the Cart, acceptable values are defined in tt:ColorDescriptor." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describes a cart pushed by the body." + }, + { + "name": "Weapon", + "type": "{http://www.onvif.org/ver20/analytics/humanbody}Weapon", + "type_name": "Weapon", + "definition": { + "kind": "complexType", + "name": "Weapon", + "fields": [ + { + "name": "Category", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Category of the weapon, acceptable values are defined in bd:WeaponCategory." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorDescriptor", + "type_name": "ColorDescriptor", + "definition": { + "kind": "complexType", + "name": "ColorDescriptor", + "fields": [ + { + "name": "ColorCluster", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Weight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Covariance", + "type": "{http://www.onvif.org/ver10/schema}ColorCovariance", + "type_name": "ColorCovariance", + "definition": { + "kind": "complexType", + "name": "ColorCovariance", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "XX", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "YY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "ZZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XY", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "XZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "YZ", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.w3.org/2001/XMLSchema}anyType", + "type_name": "anyType", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describe the Color of the weapon, acceptable values are defined in tt:ColorDescriptor." + }, + { + "name": "Pose", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Describes how the weapon is held, acceptable values are defined in bd:WeaponPose." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Describe a weapon the body carries." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Set of belongings." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ImageRef", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Image", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "BarcodeInfo", + "type": "{http://www.onvif.org/ver10/schema}BarcodeInfo", + "type_name": "BarcodeInfo", + "definition": { + "kind": "complexType", + "name": "BarcodeInfo", + "fields": [ + { + "name": "Data", + "type": "{http://www.onvif.org/ver10/schema}StringLikelihood", + "type_name": "StringLikelihood", + "definition": { + "kind": "complexType", + "name": "StringLikelihood", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Information encoded in the barcode." + }, + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}StringLikelihood", + "type_name": "StringLikelihood", + "definition": { + "kind": "complexType", + "name": "StringLikelihood", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Acceptable values are defined in tt:BarcodeType." + }, + { + "name": "PPM", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Refers to the pixels per module." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SphericalCoordinate", + "type": "{http://www.onvif.org/ver10/schema}SphericalCoordinate", + "type_name": "SphericalCoordinate", + "definition": { + "kind": "complexType", + "name": "SphericalCoordinate", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "Distance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Distance in meters to the object." + }, + { + "use": "optional", + "name": "ElevationAngle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Elevation angle in the range -90 to 90 degrees, where 0 is in level with the x-y plane." + }, + { + "use": "optional", + "name": "AzimuthAngle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Azimuth angle in the range -180 to 180 degrees counter clockwise, where 0 is rightwards." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Label", + "type": "{http://www.onvif.org/ver10/schema}LabelInfo", + "type_name": "LabelInfo", + "definition": { + "kind": "complexType", + "name": "LabelInfo", + "fields": [ + { + "name": "Authority", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Behaviour", + "type": "{http://www.onvif.org/ver10/schema}Behaviour", + "type_name": "Behaviour", + "definition": { + "kind": "complexType", + "name": "Behaviour", + "fields": [ + { + "name": "Removed", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Idle", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##other", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}BehaviourExtension", + "type_name": "BehaviourExtension", + "definition": { + "kind": "complexType", + "name": "BehaviourExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Speed", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Direction", + "type": "{http://www.onvif.org/ver10/schema}GeoOrientation", + "type_name": "GeoOrientation", + "definition": { + "kind": "complexType", + "name": "GeoOrientation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "roll", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the x axis." + }, + { + "use": "optional", + "name": "pitch", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the y axis." + }, + { + "use": "optional", + "name": "yaw", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Rotation around the z axis." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Direction the object is moving. Yaw describes the horizontal direction in the range [-180..180] where 0 is towards the right of the device and 90 is away from the device. Pitch describes the vertical direction in the range [-90..90] where 90 is upwards." + } + ], + "any": { + "namespace": "##other", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ObjectExtension", + "type_name": "ObjectExtension", + "definition": { + "kind": "complexType", + "name": "ObjectExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Parent", + "type": "{http://www.w3.org/2001/XMLSchema}integer", + "description": "Object ID of the parent object. E.g. a license plate object has a vehicle object as parent." + }, + { + "use": "optional", + "name": "ParentUUID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Object UUID of the parent object. E.g. a license plate object has a vehicle object as parent." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "ObjectTree", + "type": "{http://www.onvif.org/ver10/schema}ObjectTree", + "type_name": "ObjectTree", + "definition": { + "kind": "complexType", + "name": "ObjectTree", + "fields": [ + { + "name": "Rename", + "type": "{http://www.onvif.org/ver10/schema}Rename", + "type_name": "Rename", + "definition": { + "kind": "complexType", + "name": "Rename", + "fields": [ + { + "name": "from", + "type": "{http://www.onvif.org/ver10/schema}ObjectId", + "type_name": "ObjectId", + "definition": { + "kind": "complexType", + "name": "ObjectId", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "ObjectId", + "type": "{http://www.w3.org/2001/XMLSchema}integer" + }, + { + "use": "optional", + "name": "UUID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Object unique identifier." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "to", + "type": "{http://www.onvif.org/ver10/schema}ObjectId", + "type_name": "ObjectId", + "definition": { + "kind": "complexType", + "name": "ObjectId", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "ObjectId", + "type": "{http://www.w3.org/2001/XMLSchema}integer" + }, + { + "use": "optional", + "name": "UUID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Object unique identifier." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Split", + "type": "{http://www.onvif.org/ver10/schema}Split", + "type_name": "Split", + "definition": { + "kind": "complexType", + "name": "Split", + "fields": [ + { + "name": "from", + "type": "{http://www.onvif.org/ver10/schema}ObjectId", + "type_name": "ObjectId", + "definition": { + "kind": "complexType", + "name": "ObjectId", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "ObjectId", + "type": "{http://www.w3.org/2001/XMLSchema}integer" + }, + { + "use": "optional", + "name": "UUID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Object unique identifier." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "to", + "type": "{http://www.onvif.org/ver10/schema}ObjectId", + "type_name": "ObjectId", + "definition": { + "kind": "complexType", + "name": "ObjectId", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "ObjectId", + "type": "{http://www.w3.org/2001/XMLSchema}integer" + }, + { + "use": "optional", + "name": "UUID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Object unique identifier." + } + ] + }, + "min_occurs": 2, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Merge", + "type": "{http://www.onvif.org/ver10/schema}Merge", + "type_name": "Merge", + "definition": { + "kind": "complexType", + "name": "Merge", + "fields": [ + { + "name": "from", + "type": "{http://www.onvif.org/ver10/schema}ObjectId", + "type_name": "ObjectId", + "definition": { + "kind": "complexType", + "name": "ObjectId", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "ObjectId", + "type": "{http://www.w3.org/2001/XMLSchema}integer" + }, + { + "use": "optional", + "name": "UUID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Object unique identifier." + } + ] + }, + "min_occurs": 2, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "to", + "type": "{http://www.onvif.org/ver10/schema}ObjectId", + "type_name": "ObjectId", + "definition": { + "kind": "complexType", + "name": "ObjectId", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "ObjectId", + "type": "{http://www.w3.org/2001/XMLSchema}integer" + }, + { + "use": "optional", + "name": "UUID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Object unique identifier." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Delete", + "type": "{http://www.onvif.org/ver10/schema}ObjectId", + "type_name": "ObjectId", + "definition": { + "kind": "complexType", + "name": "ObjectId", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "ObjectId", + "type": "{http://www.w3.org/2001/XMLSchema}integer" + }, + { + "use": "optional", + "name": "UUID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Object unique identifier." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ObjectTreeExtension", + "type_name": "ObjectTreeExtension", + "definition": { + "kind": "complexType", + "name": "ObjectTreeExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}FrameExtension", + "type_name": "FrameExtension", + "definition": { + "kind": "complexType", + "name": "FrameExtension", + "fields": [ + { + "name": "MotionInCells", + "type": "{http://www.onvif.org/ver10/schema}MotionInCells", + "type_name": "MotionInCells", + "definition": { + "kind": "complexType", + "name": "MotionInCells", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Columns", + "type": "{http://www.w3.org/2001/XMLSchema}integer", + "description": "Number of columns of the cell grid (x dimension)" + }, + { + "use": "required", + "name": "Rows", + "type": "{http://www.w3.org/2001/XMLSchema}integer", + "description": "Number of rows of the cell grid (y dimension)" + }, + { + "use": "required", + "name": "Cells", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "description": "A \"1\" denotes a cell where motion is detected and a \"0\" denotes an empty cell. The first cell is in the upper-left corner. Then the cell order goes first from left to right and then from up to down. If the number of cells is not a multiple of 8, the last byte is filled with zeros. The information is run-length encoded according to PackBits coding in ISO 12369 (TIFF, Revision 6.0)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}FrameExtension2", + "type_name": "FrameExtension2", + "definition": { + "kind": "complexType", + "name": "FrameExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SceneImageRef", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SceneImage", + "type": "{http://www.w3.org/2001/XMLSchema}base64Binary", + "type_name": "base64Binary", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "AspectRatioTransformation", + "type": "{http://www.onvif.org/ver10/schema}AspectRatioTransformation", + "type_name": "AspectRatioTransformation", + "definition": { + "kind": "complexType", + "name": "AspectRatioTransformation", + "fields": [ + { + "name": "Translate", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Scale", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "ratio", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "UtcTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Default color space of Color definitions in frame. Valid values are \"RGB\" and \"YCbCr\". Defaults to \"YCbCr\"." + }, + { + "use": "optional", + "name": "Source", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional name of the analytics module that generated this frame." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Sample frame content starting with the tt:Frame node." + } + ], + "attributes": [ + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "Reference to an AnalyticsModule Type." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "AnalyticsEngineBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver20/imaging/wsdl/imaging.json b/docs/generated/wsdl/ver20/imaging/wsdl/imaging.json new file mode 100644 index 00000000..a263e6fa --- /dev/null +++ b/docs/generated/wsdl/ver20/imaging/wsdl/imaging.json @@ -0,0 +1,4388 @@ +{ + "source": "ver20/imaging/wsdl/imaging.wsdl", + "target_namespace": "http://www.onvif.org/ver20/imaging/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "ImagingPort", + "description": "Returns the capabilities of the imaging service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver20/imaging/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "ImageStabilization", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not Image Stabilization feature is supported.\n\t\t\t\t\t\tThe use of this capability is deprecated, a client should use GetOption to find out if image stabilization is supported." + }, + { + "use": "optional", + "name": "Presets", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not Imaging Presets feature is supported." + }, + { + "use": "optional", + "name": "AdaptablePreset", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not imaging preset settings can be updated." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the imaging service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ImagingBinding" + }, + { + "name": "GetImagingSettings", + "port_type": "ImagingPort", + "description": "Get the ImagingConfiguration for the requested VideoSource.", + "input": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetImagingSettingsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetImagingSettings", + "schema": { + "name": "GetImagingSettings", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the VideoSource for which the ImagingSettings." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetImagingSettingsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetImagingSettingsResponse", + "schema": { + "name": "GetImagingSettingsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ImagingSettings", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettings20", + "type_name": "ImagingSettings20", + "definition": { + "kind": "complexType", + "name": "ImagingSettings20", + "description": "Type describing the ImagingSettings of a VideoSource. The supported options and ranges can be obtained via the GetOptions command.", + "fields": [ + { + "name": "BacklightCompensation", + "type": "{http://www.onvif.org/ver10/schema}BacklightCompensation20", + "type_name": "BacklightCompensation20", + "definition": { + "kind": "complexType", + "name": "BacklightCompensation20", + "description": "Type describing whether BLC mode is enabled or disabled (on/off).", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}BacklightCompensationMode", + "type_name": "BacklightCompensationMode", + "definition": { + "kind": "simpleType", + "name": "BacklightCompensationMode", + "description": "Enumeration describing the available backlight compensation modes.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Backlight compensation is disabled." + }, + { + "value": "ON", + "description": "Backlight compensation is enabled." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Backlight compensation mode (on/off)." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter (unit unspecified)." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Enabled/disabled BLC mode (on/off)." + }, + { + "name": "Brightness", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Image brightness (unit unspecified)." + }, + { + "name": "ColorSaturation", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Color saturation of the image (unit unspecified)." + }, + { + "name": "Contrast", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contrast of the image (unit unspecified)." + }, + { + "name": "Exposure", + "type": "{http://www.onvif.org/ver10/schema}Exposure20", + "type_name": "Exposure20", + "definition": { + "kind": "complexType", + "name": "Exposure20", + "description": "Type describing the exposure settings.", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ExposureMode", + "type_name": "ExposureMode", + "definition": { + "kind": "simpleType", + "name": "ExposureMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Exposure Mode\n\t\t\t\t
    \n\t\t\t\t\t\t\t
  • Auto - Enabled the exposure algorithm on the device.
    • \n\t\t\t\t\t\t\t
  • Manual - Disabled exposure algorithm on the device.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "Priority", + "type": "{http://www.onvif.org/ver10/schema}ExposurePriority", + "type_name": "ExposurePriority", + "definition": { + "kind": "simpleType", + "name": "ExposurePriority", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "LowNoise" + }, + { + "value": "FrameRate" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The exposure priority mode (low noise/framerate)." + }, + { + "name": "Window", + "type": "{http://www.onvif.org/ver10/schema}Rectangle", + "type_name": "Rectangle", + "definition": { + "kind": "complexType", + "name": "Rectangle", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "bottom", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "top", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "right", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "left", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Rectangular exposure mask." + }, + { + "name": "MinExposureTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Minimum value of exposure time range allowed to be used by the algorithm." + }, + { + "name": "MaxExposureTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum value of exposure time range allowed to be used by the algorithm." + }, + { + "name": "MinGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Minimum value of the sensor gain range that is allowed to be used by the algorithm." + }, + { + "name": "MaxGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum value of the sensor gain range that is allowed to be used by the algorithm." + }, + { + "name": "MinIris", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Minimum value of the iris range allowed to be used by the algorithm. 0dB maps to a fully opened iris and positive values map to higher attenuation." + }, + { + "name": "MaxIris", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum value of the iris range allowed to be used by the algorithm. 0dB maps to a fully opened iris and positive values map to higher attenuation." + }, + { + "name": "ExposureTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The fixed exposure time used by the image sensor (μs)." + }, + { + "name": "Gain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The fixed gain used by the image sensor (dB)." + }, + { + "name": "Iris", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The fixed attenuation of input light affected by the iris (dB). 0dB maps to a fully opened iris and positive values map to higher attenuation." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Exposure mode of the device." + }, + { + "name": "Focus", + "type": "{http://www.onvif.org/ver10/schema}FocusConfiguration20", + "type_name": "FocusConfiguration20", + "definition": { + "kind": "complexType", + "name": "FocusConfiguration20", + "fields": [ + { + "name": "AutoFocusMode", + "type": "{http://www.onvif.org/ver10/schema}AutoFocusMode", + "type_name": "AutoFocusMode", + "definition": { + "kind": "simpleType", + "name": "AutoFocusMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mode of auto focus.\n\t\t\t\t\t\t
    \n\t\t\t\t\t\t\t
  • AUTO - The device automatically adjusts focus.
    • \n\t\t\t\t\t\t\t
  • MANUAL - The device does not automatically adjust focus.
    • \n\t\t\t\t\t\t
\n\t\t\t\t\t\tNote: for devices supporting both manual and auto operation at the same time manual operation may be supported even if the Mode parameter is set to Auto." + }, + { + "name": "DefaultSpeed", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "NearLimit", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to set autofocus near limit (unit: meter)." + }, + { + "name": "FarLimit", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to set autofocus far limit (unit: meter)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}FocusConfiguration20Extension", + "type_name": "FocusConfiguration20Extension", + "definition": { + "kind": "complexType", + "name": "FocusConfiguration20Extension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "AFMode", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Zero or more modes as defined in enumeration tt:AFModes." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Focus configuration." + }, + { + "name": "IrCutFilter", + "type": "{http://www.onvif.org/ver10/schema}IrCutFilterMode", + "type_name": "IrCutFilterMode", + "definition": { + "kind": "simpleType", + "name": "IrCutFilterMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "ON" + }, + { + "value": "OFF" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Infrared Cutoff Filter settings." + }, + { + "name": "Sharpness", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Sharpness of the Video image." + }, + { + "name": "WideDynamicRange", + "type": "{http://www.onvif.org/ver10/schema}WideDynamicRange20", + "type_name": "WideDynamicRange20", + "definition": { + "kind": "complexType", + "name": "WideDynamicRange20", + "description": "Type describing whether WDR mode is enabled or disabled (on/off).", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}WideDynamicMode", + "type_name": "WideDynamicMode", + "definition": { + "kind": "simpleType", + "name": "WideDynamicMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Wide dynamic range mode (on/off)." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter (unit unspecified)." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "WDR settings." + }, + { + "name": "WhiteBalance", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalance20", + "type_name": "WhiteBalance20", + "definition": { + "kind": "complexType", + "name": "WhiteBalance20", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalanceMode", + "type_name": "WhiteBalanceMode", + "definition": { + "kind": "simpleType", + "name": "WhiteBalanceMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "'AUTO' or 'MANUAL'" + }, + { + "name": "CrGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Rgain (unitless)." + }, + { + "name": "CbGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Bgain (unitless)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalance20Extension", + "type_name": "WhiteBalance20Extension", + "definition": { + "kind": "complexType", + "name": "WhiteBalance20Extension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "White balance settings." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettingsExtension20", + "type_name": "ImagingSettingsExtension20", + "definition": { + "kind": "complexType", + "name": "ImagingSettingsExtension20", + "fields": [ + { + "name": "ImageStabilization", + "type": "{http://www.onvif.org/ver10/schema}ImageStabilization", + "type_name": "ImageStabilization", + "definition": { + "kind": "complexType", + "name": "ImageStabilization", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ImageStabilizationMode", + "type_name": "ImageStabilizationMode", + "definition": { + "kind": "simpleType", + "name": "ImageStabilizationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "AUTO" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Image Stabilization feature." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter (unit unspecified)" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImageStabilizationExtension", + "type_name": "ImageStabilizationExtension", + "definition": { + "kind": "complexType", + "name": "ImageStabilizationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Image Stabilization feature." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettingsExtension202", + "type_name": "ImagingSettingsExtension202", + "definition": { + "kind": "complexType", + "name": "ImagingSettingsExtension202", + "fields": [ + { + "name": "IrCutFilterAutoAdjustment", + "type": "{http://www.onvif.org/ver10/schema}IrCutFilterAutoAdjustment", + "type_name": "IrCutFilterAutoAdjustment", + "definition": { + "kind": "complexType", + "name": "IrCutFilterAutoAdjustment", + "fields": [ + { + "name": "BoundaryType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies which boundaries to automatically toggle Ir cut filter following parameters are applied to. Its options shall be chosen from tt:IrCutFilterAutoBoundaryType." + }, + { + "name": "BoundaryOffset", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Adjusts boundary exposure level for toggling Ir cut filter to on/off specified with unitless normalized value from +1.0 to -1.0. Zero is default and -1.0 is the darkest adjustment (Unitless)." + }, + { + "name": "ResponseTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Delay time of toggling Ir cut filter to on/off after crossing of the boundary exposure levels." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}IrCutFilterAutoAdjustmentExtension", + "type_name": "IrCutFilterAutoAdjustmentExtension", + "definition": { + "kind": "complexType", + "name": "IrCutFilterAutoAdjustmentExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "An optional parameter applied to only auto mode to adjust timing of toggling Ir cut filter." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettingsExtension203", + "type_name": "ImagingSettingsExtension203", + "definition": { + "kind": "complexType", + "name": "ImagingSettingsExtension203", + "fields": [ + { + "name": "ToneCompensation", + "type": "{http://www.onvif.org/ver10/schema}ToneCompensation", + "type_name": "ToneCompensation", + "definition": { + "kind": "complexType", + "name": "ToneCompensation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable or automatic ToneCompensation feature. Its options shall be chosen from tt:ToneCompensationMode Type." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter specified with unitless normalized value from 0.0 to +1.0." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ToneCompensationExtension", + "type_name": "ToneCompensationExtension", + "definition": { + "kind": "complexType", + "name": "ToneCompensationExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Image Contrast Compensation." + }, + { + "name": "Defogging", + "type": "{http://www.onvif.org/ver10/schema}Defogging", + "type_name": "Defogging", + "definition": { + "kind": "complexType", + "name": "Defogging", + "fields": [ + { + "name": "Mode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable or automatic Defogging feature. Its options shall be chosen from tt:DefoggingMode Type." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter specified with unitless normalized value from 0.0 to +1.0." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}DefoggingExtension", + "type_name": "DefoggingExtension", + "definition": { + "kind": "complexType", + "name": "DefoggingExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Image Defogging." + }, + { + "name": "NoiseReduction", + "type": "{http://www.onvif.org/ver10/schema}NoiseReduction", + "type_name": "NoiseReduction", + "definition": { + "kind": "complexType", + "name": "NoiseReduction", + "fields": [ + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Level parameter specified with unitless normalized value from 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Image Noise Reduction." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettingsExtension204", + "type_name": "ImagingSettingsExtension204", + "definition": { + "kind": "complexType", + "name": "ImagingSettingsExtension204", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "ImagingSettings for the VideoSource that was requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ImagingBinding" + }, + { + "name": "SetImagingSettings", + "port_type": "ImagingPort", + "description": "Set the ImagingConfiguration for the requested VideoSource.", + "input": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}SetImagingSettingsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}SetImagingSettings", + "schema": { + "name": "SetImagingSettings", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ImagingSettings", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettings20", + "type_name": "ImagingSettings20", + "definition": { + "kind": "complexType", + "name": "ImagingSettings20", + "description": "Type describing the ImagingSettings of a VideoSource. The supported options and ranges can be obtained via the GetOptions command.", + "fields": [ + { + "name": "BacklightCompensation", + "type": "{http://www.onvif.org/ver10/schema}BacklightCompensation20", + "type_name": "BacklightCompensation20", + "definition": { + "kind": "complexType", + "name": "BacklightCompensation20", + "description": "Type describing whether BLC mode is enabled or disabled (on/off).", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}BacklightCompensationMode", + "type_name": "BacklightCompensationMode", + "definition": { + "kind": "simpleType", + "name": "BacklightCompensationMode", + "description": "Enumeration describing the available backlight compensation modes.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Backlight compensation is disabled." + }, + { + "value": "ON", + "description": "Backlight compensation is enabled." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Backlight compensation mode (on/off)." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter (unit unspecified)." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Enabled/disabled BLC mode (on/off)." + }, + { + "name": "Brightness", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Image brightness (unit unspecified)." + }, + { + "name": "ColorSaturation", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Color saturation of the image (unit unspecified)." + }, + { + "name": "Contrast", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contrast of the image (unit unspecified)." + }, + { + "name": "Exposure", + "type": "{http://www.onvif.org/ver10/schema}Exposure20", + "type_name": "Exposure20", + "definition": { + "kind": "complexType", + "name": "Exposure20", + "description": "Type describing the exposure settings.", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ExposureMode", + "type_name": "ExposureMode", + "definition": { + "kind": "simpleType", + "name": "ExposureMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Exposure Mode\n\t\t\t\t
    \n\t\t\t\t\t\t\t
  • Auto - Enabled the exposure algorithm on the device.
    • \n\t\t\t\t\t\t\t
  • Manual - Disabled exposure algorithm on the device.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "Priority", + "type": "{http://www.onvif.org/ver10/schema}ExposurePriority", + "type_name": "ExposurePriority", + "definition": { + "kind": "simpleType", + "name": "ExposurePriority", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "LowNoise" + }, + { + "value": "FrameRate" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The exposure priority mode (low noise/framerate)." + }, + { + "name": "Window", + "type": "{http://www.onvif.org/ver10/schema}Rectangle", + "type_name": "Rectangle", + "definition": { + "kind": "complexType", + "name": "Rectangle", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "bottom", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "top", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "right", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "left", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Rectangular exposure mask." + }, + { + "name": "MinExposureTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Minimum value of exposure time range allowed to be used by the algorithm." + }, + { + "name": "MaxExposureTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum value of exposure time range allowed to be used by the algorithm." + }, + { + "name": "MinGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Minimum value of the sensor gain range that is allowed to be used by the algorithm." + }, + { + "name": "MaxGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum value of the sensor gain range that is allowed to be used by the algorithm." + }, + { + "name": "MinIris", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Minimum value of the iris range allowed to be used by the algorithm. 0dB maps to a fully opened iris and positive values map to higher attenuation." + }, + { + "name": "MaxIris", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Maximum value of the iris range allowed to be used by the algorithm. 0dB maps to a fully opened iris and positive values map to higher attenuation." + }, + { + "name": "ExposureTime", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The fixed exposure time used by the image sensor (μs)." + }, + { + "name": "Gain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The fixed gain used by the image sensor (dB)." + }, + { + "name": "Iris", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The fixed attenuation of input light affected by the iris (dB). 0dB maps to a fully opened iris and positive values map to higher attenuation." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Exposure mode of the device." + }, + { + "name": "Focus", + "type": "{http://www.onvif.org/ver10/schema}FocusConfiguration20", + "type_name": "FocusConfiguration20", + "definition": { + "kind": "complexType", + "name": "FocusConfiguration20", + "fields": [ + { + "name": "AutoFocusMode", + "type": "{http://www.onvif.org/ver10/schema}AutoFocusMode", + "type_name": "AutoFocusMode", + "definition": { + "kind": "simpleType", + "name": "AutoFocusMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mode of auto focus.\n\t\t\t\t\t\t
    \n\t\t\t\t\t\t\t
  • AUTO - The device automatically adjusts focus.
    • \n\t\t\t\t\t\t\t
  • MANUAL - The device does not automatically adjust focus.
    • \n\t\t\t\t\t\t
\n\t\t\t\t\t\tNote: for devices supporting both manual and auto operation at the same time manual operation may be supported even if the Mode parameter is set to Auto." + }, + { + "name": "DefaultSpeed", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "NearLimit", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to set autofocus near limit (unit: meter)." + }, + { + "name": "FarLimit", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to set autofocus far limit (unit: meter)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}FocusConfiguration20Extension", + "type_name": "FocusConfiguration20Extension", + "definition": { + "kind": "complexType", + "name": "FocusConfiguration20Extension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "AFMode", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Zero or more modes as defined in enumeration tt:AFModes." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Focus configuration." + }, + { + "name": "IrCutFilter", + "type": "{http://www.onvif.org/ver10/schema}IrCutFilterMode", + "type_name": "IrCutFilterMode", + "definition": { + "kind": "simpleType", + "name": "IrCutFilterMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "ON" + }, + { + "value": "OFF" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Infrared Cutoff Filter settings." + }, + { + "name": "Sharpness", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Sharpness of the Video image." + }, + { + "name": "WideDynamicRange", + "type": "{http://www.onvif.org/ver10/schema}WideDynamicRange20", + "type_name": "WideDynamicRange20", + "definition": { + "kind": "complexType", + "name": "WideDynamicRange20", + "description": "Type describing whether WDR mode is enabled or disabled (on/off).", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}WideDynamicMode", + "type_name": "WideDynamicMode", + "definition": { + "kind": "simpleType", + "name": "WideDynamicMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Wide dynamic range mode (on/off)." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter (unit unspecified)." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "WDR settings." + }, + { + "name": "WhiteBalance", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalance20", + "type_name": "WhiteBalance20", + "definition": { + "kind": "complexType", + "name": "WhiteBalance20", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalanceMode", + "type_name": "WhiteBalanceMode", + "definition": { + "kind": "simpleType", + "name": "WhiteBalanceMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "'AUTO' or 'MANUAL'" + }, + { + "name": "CrGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Rgain (unitless)." + }, + { + "name": "CbGain", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Bgain (unitless)." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalance20Extension", + "type_name": "WhiteBalance20Extension", + "definition": { + "kind": "complexType", + "name": "WhiteBalance20Extension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "White balance settings." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettingsExtension20", + "type_name": "ImagingSettingsExtension20", + "definition": { + "kind": "complexType", + "name": "ImagingSettingsExtension20", + "fields": [ + { + "name": "ImageStabilization", + "type": "{http://www.onvif.org/ver10/schema}ImageStabilization", + "type_name": "ImageStabilization", + "definition": { + "kind": "complexType", + "name": "ImageStabilization", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ImageStabilizationMode", + "type_name": "ImageStabilizationMode", + "definition": { + "kind": "simpleType", + "name": "ImageStabilizationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "AUTO" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Image Stabilization feature." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter (unit unspecified)" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImageStabilizationExtension", + "type_name": "ImageStabilizationExtension", + "definition": { + "kind": "complexType", + "name": "ImageStabilizationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Image Stabilization feature." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettingsExtension202", + "type_name": "ImagingSettingsExtension202", + "definition": { + "kind": "complexType", + "name": "ImagingSettingsExtension202", + "fields": [ + { + "name": "IrCutFilterAutoAdjustment", + "type": "{http://www.onvif.org/ver10/schema}IrCutFilterAutoAdjustment", + "type_name": "IrCutFilterAutoAdjustment", + "definition": { + "kind": "complexType", + "name": "IrCutFilterAutoAdjustment", + "fields": [ + { + "name": "BoundaryType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies which boundaries to automatically toggle Ir cut filter following parameters are applied to. Its options shall be chosen from tt:IrCutFilterAutoBoundaryType." + }, + { + "name": "BoundaryOffset", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Adjusts boundary exposure level for toggling Ir cut filter to on/off specified with unitless normalized value from +1.0 to -1.0. Zero is default and -1.0 is the darkest adjustment (Unitless)." + }, + { + "name": "ResponseTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Delay time of toggling Ir cut filter to on/off after crossing of the boundary exposure levels." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}IrCutFilterAutoAdjustmentExtension", + "type_name": "IrCutFilterAutoAdjustmentExtension", + "definition": { + "kind": "complexType", + "name": "IrCutFilterAutoAdjustmentExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "An optional parameter applied to only auto mode to adjust timing of toggling Ir cut filter." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettingsExtension203", + "type_name": "ImagingSettingsExtension203", + "definition": { + "kind": "complexType", + "name": "ImagingSettingsExtension203", + "fields": [ + { + "name": "ToneCompensation", + "type": "{http://www.onvif.org/ver10/schema}ToneCompensation", + "type_name": "ToneCompensation", + "definition": { + "kind": "complexType", + "name": "ToneCompensation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable or automatic ToneCompensation feature. Its options shall be chosen from tt:ToneCompensationMode Type." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter specified with unitless normalized value from 0.0 to +1.0." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ToneCompensationExtension", + "type_name": "ToneCompensationExtension", + "definition": { + "kind": "complexType", + "name": "ToneCompensationExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Image Contrast Compensation." + }, + { + "name": "Defogging", + "type": "{http://www.onvif.org/ver10/schema}Defogging", + "type_name": "Defogging", + "definition": { + "kind": "complexType", + "name": "Defogging", + "fields": [ + { + "name": "Mode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable or automatic Defogging feature. Its options shall be chosen from tt:DefoggingMode Type." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level parameter specified with unitless normalized value from 0.0 to +1.0." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}DefoggingExtension", + "type_name": "DefoggingExtension", + "definition": { + "kind": "complexType", + "name": "DefoggingExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Image Defogging." + }, + { + "name": "NoiseReduction", + "type": "{http://www.onvif.org/ver10/schema}NoiseReduction", + "type_name": "NoiseReduction", + "definition": { + "kind": "complexType", + "name": "NoiseReduction", + "fields": [ + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Level parameter specified with unitless normalized value from 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure Image Noise Reduction." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingSettingsExtension204", + "type_name": "ImagingSettingsExtension204", + "definition": { + "kind": "complexType", + "name": "ImagingSettingsExtension204", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}SetImagingSettingsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}SetImagingSettingsResponse", + "schema": { + "name": "SetImagingSettingsResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ImagingBinding" + }, + { + "name": "GetOptions", + "port_type": "ImagingPort", + "description": "This operation gets the valid ranges for the imaging parameters that have device specific ranges. This command is mandatory for all device implementing the imaging service. The command returns all supported parameters and their ranges such that these can be applied to the SetImagingSettings command. For read-only parameters which cannot be modified via the SetImagingSettings command only a single option or identical Min and Max values is provided.", + "input": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetOptions", + "schema": { + "name": "GetOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the VideoSource for which the imaging parameter options are requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetOptionsResponse", + "schema": { + "name": "GetOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ImagingOptions", + "type": "{http://www.onvif.org/ver10/schema}ImagingOptions20", + "type_name": "ImagingOptions20", + "definition": { + "kind": "complexType", + "name": "ImagingOptions20", + "fields": [ + { + "name": "BacklightCompensation", + "type": "{http://www.onvif.org/ver10/schema}BacklightCompensationOptions20", + "type_name": "BacklightCompensationOptions20", + "definition": { + "kind": "complexType", + "name": "BacklightCompensationOptions20", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}BacklightCompensationMode", + "type_name": "BacklightCompensationMode", + "definition": { + "kind": "simpleType", + "name": "BacklightCompensationMode", + "description": "Enumeration describing the available backlight compensation modes.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Backlight compensation is disabled." + }, + { + "value": "ON", + "description": "Backlight compensation is enabled." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "'ON' or 'OFF'" + }, + { + "name": "Level", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Level range of BacklightCompensation." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of Backlight Compensation." + }, + { + "name": "Brightness", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of Brightness." + }, + { + "name": "ColorSaturation", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of Color Saturation." + }, + { + "name": "Contrast", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of Contrast." + }, + { + "name": "Exposure", + "type": "{http://www.onvif.org/ver10/schema}ExposureOptions20", + "type_name": "ExposureOptions20", + "definition": { + "kind": "complexType", + "name": "ExposureOptions20", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ExposureMode", + "type_name": "ExposureMode", + "definition": { + "kind": "simpleType", + "name": "ExposureMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Exposure Mode\n\t\t\t\t
    \n\t\t\t\t\t\t\t
  • Auto - Enabled the exposure algorithm on the device.
    • \n\t\t\t\t\t\t\t
  • Manual - Disabled exposure algorithm on the device.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "Priority", + "type": "{http://www.onvif.org/ver10/schema}ExposurePriority", + "type_name": "ExposurePriority", + "definition": { + "kind": "simpleType", + "name": "ExposurePriority", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "LowNoise" + }, + { + "value": "FrameRate" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The exposure priority mode (low noise/framerate)." + }, + { + "name": "MinExposureTime", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of the Minimum ExposureTime." + }, + { + "name": "MaxExposureTime", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of the Maximum ExposureTime." + }, + { + "name": "MinGain", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of the Minimum Gain." + }, + { + "name": "MaxGain", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of the Maximum Gain." + }, + { + "name": "MinIris", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of the Minimum Iris." + }, + { + "name": "MaxIris", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of the Maximum Iris." + }, + { + "name": "ExposureTime", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of the ExposureTime." + }, + { + "name": "Gain", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of the Gain." + }, + { + "name": "Iris", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of the Iris." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of Exposure." + }, + { + "name": "Focus", + "type": "{http://www.onvif.org/ver10/schema}FocusOptions20", + "type_name": "FocusOptions20", + "definition": { + "kind": "complexType", + "name": "FocusOptions20", + "fields": [ + { + "name": "AutoFocusModes", + "type": "{http://www.onvif.org/ver10/schema}AutoFocusMode", + "type_name": "AutoFocusMode", + "definition": { + "kind": "simpleType", + "name": "AutoFocusMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Supported modes for auto focus.\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • AUTO - The device supports automatic focus adjustment.
    • \n\t\t\t\t\t\t
  • MANUAL - The device supports manual focus adjustment.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "DefaultSpeed", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of DefaultSpeed." + }, + { + "name": "NearLimit", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of NearLimit." + }, + { + "name": "FarLimit", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of FarLimit." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}FocusOptions20Extension", + "type_name": "FocusOptions20Extension", + "definition": { + "kind": "complexType", + "name": "FocusOptions20Extension", + "fields": [ + { + "name": "AFModes", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "type_name": "StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Supported options for auto focus. Options shall be chosen from tt:AFModes." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of Focus." + }, + { + "name": "IrCutFilterModes", + "type": "{http://www.onvif.org/ver10/schema}IrCutFilterMode", + "type_name": "IrCutFilterMode", + "definition": { + "kind": "simpleType", + "name": "IrCutFilterMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "ON" + }, + { + "value": "OFF" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Valid range of IrCutFilterModes." + }, + { + "name": "Sharpness", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of Sharpness." + }, + { + "name": "WideDynamicRange", + "type": "{http://www.onvif.org/ver10/schema}WideDynamicRangeOptions20", + "type_name": "WideDynamicRangeOptions20", + "definition": { + "kind": "complexType", + "name": "WideDynamicRangeOptions20", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}WideDynamicMode", + "type_name": "WideDynamicMode", + "definition": { + "kind": "simpleType", + "name": "WideDynamicMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Level", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of WideDynamicRange." + }, + { + "name": "WhiteBalance", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalanceOptions20", + "type_name": "WhiteBalanceOptions20", + "definition": { + "kind": "complexType", + "name": "WhiteBalanceOptions20", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalanceMode", + "type_name": "WhiteBalanceMode", + "definition": { + "kind": "simpleType", + "name": "WhiteBalanceMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AUTO" + }, + { + "value": "MANUAL" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Mode of WhiteBalance.\n\t\t\t\t
    \n\t\t\t\t\t\t\t
  • AUTO
    • \n\t\t\t\t\t\t\t
  • MANUAL
    • \n\t\t\t\t\t\t
" + }, + { + "name": "YrGain", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "YbGain", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}WhiteBalanceOptions20Extension", + "type_name": "WhiteBalanceOptions20Extension", + "definition": { + "kind": "complexType", + "name": "WhiteBalanceOptions20Extension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of WhiteBalance." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingOptions20Extension", + "type_name": "ImagingOptions20Extension", + "definition": { + "kind": "complexType", + "name": "ImagingOptions20Extension", + "fields": [ + { + "name": "ImageStabilization", + "type": "{http://www.onvif.org/ver10/schema}ImageStabilizationOptions", + "type_name": "ImageStabilizationOptions", + "definition": { + "kind": "complexType", + "name": "ImageStabilizationOptions", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ImageStabilizationMode", + "type_name": "ImageStabilizationMode", + "definition": { + "kind": "simpleType", + "name": "ImageStabilizationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "AUTO" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Supported options of Image Stabilization mode parameter." + }, + { + "name": "Level", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid range of the Image Stabilization." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImageStabilizationOptionsExtension", + "type_name": "ImageStabilizationOptionsExtension", + "definition": { + "kind": "complexType", + "name": "ImageStabilizationOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Options of parameters for Image Stabilization feature." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingOptions20Extension2", + "type_name": "ImagingOptions20Extension2", + "definition": { + "kind": "complexType", + "name": "ImagingOptions20Extension2", + "fields": [ + { + "name": "IrCutFilterAutoAdjustment", + "type": "{http://www.onvif.org/ver10/schema}IrCutFilterAutoAdjustmentOptions", + "type_name": "IrCutFilterAutoAdjustmentOptions", + "definition": { + "kind": "complexType", + "name": "IrCutFilterAutoAdjustmentOptions", + "fields": [ + { + "name": "BoundaryType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Supported options of boundary types for adjustment of Ir cut filter auto mode. The options shall be chosen from tt:IrCutFilterAutoBoundaryType." + }, + { + "name": "BoundaryOffset", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not boundary offset for toggling Ir cut filter is supported." + }, + { + "name": "ResponseTimeRange", + "type": "{http://www.onvif.org/ver10/schema}DurationRange", + "type_name": "DurationRange", + "definition": { + "kind": "complexType", + "name": "DurationRange", + "description": "Range of duration greater equal Min duration and less equal Max duration.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Supported range of delay time for toggling Ir cut filter." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}IrCutFilterAutoAdjustmentOptionsExtension", + "type_name": "IrCutFilterAutoAdjustmentOptionsExtension", + "definition": { + "kind": "complexType", + "name": "IrCutFilterAutoAdjustmentOptionsExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Options of parameters for adjustment of Ir cut filter auto mode." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingOptions20Extension3", + "type_name": "ImagingOptions20Extension3", + "definition": { + "kind": "complexType", + "name": "ImagingOptions20Extension3", + "fields": [ + { + "name": "ToneCompensationOptions", + "type": "{http://www.onvif.org/ver10/schema}ToneCompensationOptions", + "type_name": "ToneCompensationOptions", + "definition": { + "kind": "complexType", + "name": "ToneCompensationOptions", + "fields": [ + { + "name": "Mode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Supported options for Tone Compensation mode. Its options shall be chosen from tt:ToneCompensationMode Type." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not support Level parameter for Tone Compensation." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Options of parameters for Tone Compensation feature." + }, + { + "name": "DefoggingOptions", + "type": "{http://www.onvif.org/ver10/schema}DefoggingOptions", + "type_name": "DefoggingOptions", + "definition": { + "kind": "complexType", + "name": "DefoggingOptions", + "fields": [ + { + "name": "Mode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Supported options for Defogging mode. Its options shall be chosen from tt:DefoggingMode Type." + }, + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not support Level parameter for Defogging." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Options of parameters for Defogging feature." + }, + { + "name": "NoiseReductionOptions", + "type": "{http://www.onvif.org/ver10/schema}NoiseReductionOptions", + "type_name": "NoiseReductionOptions", + "definition": { + "kind": "complexType", + "name": "NoiseReductionOptions", + "fields": [ + { + "name": "Level", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not support Level parameter for NoiseReduction." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Options of parameter for Noise Reduction feature." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingOptions20Extension4", + "type_name": "ImagingOptions20Extension4", + "definition": { + "kind": "complexType", + "name": "ImagingOptions20Extension4", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Valid ranges for the imaging parameters that are categorized as device specific." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ImagingBinding" + }, + { + "name": "Move", + "port_type": "ImagingPort", + "description": "The Move command moves the focus lens in an absolute, a relative or in a continuous manner from its current position. The speed argument is optional for absolute and relative control, but required for continuous. If no speed argument is used, the default speed is used. Focus adjustments through this operation will turn off the autofocus. A device with support for remote focus control should support absolute, relative or continuous control through the Move operation. The supported MoveOpions are signalled via the GetMoveOptions command. At least one focus control capability is required for this operation to be functional. The move operation contains the following commands: Absolute – Requires position parameter and optionally takes a speed argument. A unitless type is used by default for focus positioning and speed. Optionally, if supported, the position may be requested in m-1 units. Relative – Requires distance parameter and optionally takes a speed argument. Negative distance means negative direction. Continuous – Requires a speed argument. Negative speed argument means negative direction.", + "input": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}MoveRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}Move", + "schema": { + "name": "Move", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the VideoSource for the requested move (focus) operation." + }, + { + "name": "Focus", + "type": "{http://www.onvif.org/ver10/schema}FocusMove", + "type_name": "FocusMove", + "definition": { + "kind": "complexType", + "name": "FocusMove", + "fields": [ + { + "name": "Absolute", + "type": "{http://www.onvif.org/ver10/schema}AbsoluteFocus", + "type_name": "AbsoluteFocus", + "definition": { + "kind": "complexType", + "name": "AbsoluteFocus", + "fields": [ + { + "name": "Position", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Position parameter for the absolute focus control." + }, + { + "name": "Speed", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Speed parameter for the absolute focus control." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Parameters for the absolute focus control." + }, + { + "name": "Relative", + "type": "{http://www.onvif.org/ver10/schema}RelativeFocus", + "type_name": "RelativeFocus", + "definition": { + "kind": "complexType", + "name": "RelativeFocus", + "fields": [ + { + "name": "Distance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Distance parameter for the relative focus control." + }, + { + "name": "Speed", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Speed parameter for the relative focus control." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Parameters for the relative focus control." + }, + { + "name": "Continuous", + "type": "{http://www.onvif.org/ver10/schema}ContinuousFocus", + "type_name": "ContinuousFocus", + "definition": { + "kind": "complexType", + "name": "ContinuousFocus", + "fields": [ + { + "name": "Speed", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Speed parameter for the Continuous focus control." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Parameter for the continuous focus control." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Content of the requested move (focus) operation." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}MoveResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}MoveResponse", + "schema": { + "name": "MoveResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ImagingBinding" + }, + { + "name": "GetMoveOptions", + "port_type": "ImagingPort", + "description": "Imaging move operation options supported for the Video source.", + "input": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetMoveOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetMoveOptions", + "schema": { + "name": "GetMoveOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the VideoSource for the requested move options." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetMoveOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetMoveOptionsResponse", + "schema": { + "name": "GetMoveOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "MoveOptions", + "type": "{http://www.onvif.org/ver10/schema}MoveOptions20", + "type_name": "MoveOptions20", + "definition": { + "kind": "complexType", + "name": "MoveOptions20", + "fields": [ + { + "name": "Absolute", + "type": "{http://www.onvif.org/ver10/schema}AbsoluteFocusOptions", + "type_name": "AbsoluteFocusOptions", + "definition": { + "kind": "complexType", + "name": "AbsoluteFocusOptions", + "fields": [ + { + "name": "Position", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Valid ranges of the position." + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid ranges of the speed." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid ranges for the absolute control." + }, + { + "name": "Relative", + "type": "{http://www.onvif.org/ver10/schema}RelativeFocusOptions20", + "type_name": "RelativeFocusOptions20", + "definition": { + "kind": "complexType", + "name": "RelativeFocusOptions20", + "fields": [ + { + "name": "Distance", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Valid ranges of the distance." + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid ranges of the speed." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid ranges for the relative control." + }, + { + "name": "Continuous", + "type": "{http://www.onvif.org/ver10/schema}ContinuousFocusOptions", + "type_name": "ContinuousFocusOptions", + "definition": { + "kind": "complexType", + "name": "ContinuousFocusOptions", + "fields": [ + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Valid ranges of the speed." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Valid ranges for the continuous control." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Valid ranges for the focus lens move options." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ImagingBinding" + }, + { + "name": "Stop", + "port_type": "ImagingPort", + "description": "The Stop command stops all ongoing focus movements of the lense. A device with support for remote focus control as signalled via the GetMoveOptions supports this command. The operation will not affect ongoing autofocus operation.", + "input": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}StopRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}Stop", + "schema": { + "name": "Stop", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the VideoSource where the focus movement should be stopped." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}StopResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}StopResponse", + "schema": { + "name": "StopResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ImagingBinding" + }, + { + "name": "GetStatus", + "port_type": "ImagingPort", + "description": "Via this command the current status of the Move operation can be requested. Supported for this command is available if the support for the Move operation is signalled via GetMoveOptions.", + "input": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetStatusRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetStatus", + "schema": { + "name": "GetStatus", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the VideoSource where the imaging status should be requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetStatusResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetStatusResponse", + "schema": { + "name": "GetStatusResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Status", + "type": "{http://www.onvif.org/ver10/schema}ImagingStatus20", + "type_name": "ImagingStatus20", + "definition": { + "kind": "complexType", + "name": "ImagingStatus20", + "fields": [ + { + "name": "FocusStatus20", + "type": "{http://www.onvif.org/ver10/schema}FocusStatus20", + "type_name": "FocusStatus20", + "definition": { + "kind": "complexType", + "name": "FocusStatus20", + "fields": [ + { + "name": "Position", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Status of focus position." + }, + { + "name": "MoveStatus", + "type": "{http://www.onvif.org/ver10/schema}MoveStatus", + "type_name": "MoveStatus", + "definition": { + "kind": "simpleType", + "name": "MoveStatus", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IDLE" + }, + { + "value": "MOVING" + }, + { + "value": "UNKNOWN" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Status of focus MoveStatus." + }, + { + "name": "Error", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Error status of focus." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}FocusStatus20Extension", + "type_name": "FocusStatus20Extension", + "definition": { + "kind": "complexType", + "name": "FocusStatus20Extension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Status of focus." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ImagingStatus20Extension", + "type_name": "ImagingStatus20Extension", + "definition": { + "kind": "complexType", + "name": "ImagingStatus20Extension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Requested imaging status." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ImagingBinding" + }, + { + "name": "GetPresets", + "port_type": "ImagingPort", + "description": "Via this command the list of available Imaging Presets can be requested.", + "input": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetPresetsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetPresets", + "schema": { + "name": "GetPresets", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the VideoSource where the operation should take place." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetPresetsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetPresetsResponse", + "schema": { + "name": "GetPresetsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Preset", + "type": "{http://www.onvif.org/ver20/imaging/wsdl}ImagingPreset", + "type_name": "ImagingPreset", + "definition": { + "kind": "complexType", + "name": "ImagingPreset", + "description": "Type describing the Imaging Preset settings.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Human readable name of the Imaging Preset." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of this Imaging Preset." + }, + { + "use": "required", + "name": "type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Indicates Imaging Preset Type. Use timg:ImagingPresetType. \n\t\t\t\t\t\tUsed for multi-language support and display." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of Imaging Presets which are available for the requested VideoSource." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ImagingBinding" + }, + { + "name": "GetCurrentPreset", + "port_type": "ImagingPort", + "description": "Via this command the last Imaging Preset applied can be requested. If the camera configuration does not match any of the existing Imaging Presets, the output of GetCurrentPreset shall be Empty. GetCurrentPreset shall return 0 if Imaging Presets are not supported by the Video Source.", + "input": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetCurrentPresetRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetCurrentPreset", + "schema": { + "name": "GetCurrentPreset", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the VideoSource where the current Imaging Preset should be requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}GetCurrentPresetResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}GetCurrentPresetResponse", + "schema": { + "name": "GetCurrentPresetResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Preset", + "type": "{http://www.onvif.org/ver20/imaging/wsdl}ImagingPreset", + "type_name": "ImagingPreset", + "definition": { + "kind": "complexType", + "name": "ImagingPreset", + "description": "Type describing the Imaging Preset settings.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Human readable name of the Imaging Preset." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of this Imaging Preset." + }, + { + "use": "required", + "name": "type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Indicates Imaging Preset Type. Use timg:ImagingPresetType. \n\t\t\t\t\t\tUsed for multi-language support and display." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Current Imaging Preset in use for the specified Video Source." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ImagingBinding" + }, + { + "name": "SetCurrentPreset", + "port_type": "ImagingPort", + "description": "The SetCurrentPreset command shall request a given Imaging Preset to be applied to the specified Video Source. SetCurrentPreset shall only be available for Video Sources with Imaging Presets Capability. Imaging Presets are defined by the Manufacturer, and offered as a tool to simplify Imaging Settings adjustments for specific scene content. When the new Imaging Preset is applied by SetCurrentPreset, the Device shall adjust the Video Source settings to match those defined by the specified Imaging Preset.", + "input": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}SetCurrentPresetRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}SetCurrentPreset", + "schema": { + "name": "SetCurrentPreset", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the VideoSource to which the specified Imaging Preset should be applied." + }, + { + "name": "PresetToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference token to the Imaging Preset to be applied to the specified Video Source." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/imaging/wsdl}SetCurrentPresetResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/imaging/wsdl}SetCurrentPresetResponse", + "schema": { + "name": "SetCurrentPresetResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "ImagingBinding" + } + ] +} diff --git a/docs/generated/wsdl/ver20/media/wsdl/media.json b/docs/generated/wsdl/ver20/media/wsdl/media.json new file mode 100644 index 00000000..9207c51a --- /dev/null +++ b/docs/generated/wsdl/ver20/media/wsdl/media.json @@ -0,0 +1,18116 @@ +{ + "source": "ver20/media/wsdl/media.wsdl", + "target_namespace": "http://www.onvif.org/ver20/media/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "Media2", + "description": "Returns the capabilities of the media service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver20/media/wsdl}Capabilities2", + "type_name": "Capabilities2", + "definition": { + "kind": "complexType", + "name": "Capabilities2", + "fields": [ + { + "name": "ProfileCapabilities", + "type": "{http://www.onvif.org/ver20/media/wsdl}ProfileCapabilities", + "type_name": "ProfileCapabilities", + "definition": { + "kind": "complexType", + "name": "ProfileCapabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "MaximumNumberOfProfiles", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of profiles supported." + }, + { + "use": "optional", + "name": "ConfigurationsSupported", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "The configurations supported by the device as defined by tr2:ConfigurationEnumeration. The enumeration value \"All\" shall not be included in this list." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Media profile capabilities." + }, + { + "name": "StreamingCapabilities", + "type": "{http://www.onvif.org/ver20/media/wsdl}StreamingCapabilities", + "type_name": "StreamingCapabilities", + "definition": { + "kind": "complexType", + "name": "StreamingCapabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "RTSPStreaming", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for live media streaming via RTSP." + }, + { + "use": "optional", + "name": "RTPMulticast", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for RTP multicast." + }, + { + "use": "optional", + "name": "RTP_RTSP_TCP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for RTP/RTSP/TCP." + }, + { + "use": "optional", + "name": "NonAggregateControl", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for non aggregate RTSP control." + }, + { + "use": "optional", + "name": "RTSPWebSocketUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "If streaming over WebSocket is supported, this shall return the RTSP WebSocket URI as described in Streaming Specification Section 5.1.1.5." + }, + { + "use": "optional", + "name": "AutoStartMulticast", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for non-RTSP controlled multicast streaming." + }, + { + "use": "optional", + "name": "SecureRTSPStreaming", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for live media streaming via RTSPS and SRTP." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Streaming capabilities." + }, + { + "name": "AudioClipCapabilities", + "type": "{http://www.onvif.org/ver20/media/wsdl}AudioClipCapabilities", + "type_name": "AudioClipCapabilities", + "definition": { + "kind": "complexType", + "name": "AudioClipCapabilities", + "fields": [ + { + "name": "TTSCapabilities", + "type": "{http://www.onvif.org/ver20/media/wsdl}TTSCapabilities", + "type_name": "TTSCapabilities", + "definition": { + "kind": "complexType", + "name": "TTSCapabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "MaxContentLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Indicates the maximum length of content of a text for device to convert to an audio clip." + }, + { + "use": "optional", + "name": "TTSLanguage", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported languages. Uses ISO 639-1 alpha-2 language codes, such as\"en\" for English. See Codes for the Representation of Names of Languages.\n Optionally combined with ISO 3166-1 alpha-2 country codes using the \"language-country\" format to specify regional variations, such as\"en-US\" for American English. For country codes, see ISO 3166-1 Country Codes." + }, + { + "use": "optional", + "name": "TTSVoiceType", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported voice types. See tr2: TTSVoiceType." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates device has TTS capability." + } + ], + "attributes": [ + { + "use": "optional", + "name": "MaxAudioClipLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Indicates the maximum number of audio clips that can be uploaded to the device." + }, + { + "use": "optional", + "name": "MaxAudioClipSize", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Indicates the maximum size of the audio clip that can be uploaded, in KB." + }, + { + "use": "optional", + "name": "SupportedAudioClipFormat", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Enumerates the supported audio clip formats. See tr2: SupportedAudioClipFormat." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Audio clip capabilities." + }, + { + "name": "MulticastAudioDecoderCapabilities", + "type": "{http://www.onvif.org/ver20/media/wsdl}MulticastAudioDecoderCapabilities", + "type_name": "MulticastAudioDecoderCapabilities", + "definition": { + "kind": "complexType", + "name": "MulticastAudioDecoderCapabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "MulticastAudioDecoder", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for multicast audio decoder." + }, + { + "use": "optional", + "name": "SRTP", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether the SRTP is supported in MulticastAudioDecoder or not." + }, + { + "use": "optional", + "name": "IPv6", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether the IPv6 is supported in MulticastAudioDecoder or not." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "MulticastAudioDecoder capabilities." + } + ], + "attributes": [ + { + "use": "optional", + "name": "SnapshotUri", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates if GetSnapshotUri is supported." + }, + { + "use": "optional", + "name": "Rotation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not Rotation feature is supported." + }, + { + "use": "optional", + "name": "VideoSourceMode", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates the support for changing video source mode." + }, + { + "use": "optional", + "name": "OSD", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates if OSD is supported." + }, + { + "use": "optional", + "name": "TemporaryOSDText", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates the support for temporary osd text configuration." + }, + { + "use": "optional", + "name": "Mask", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates if Masking is supported." + }, + { + "use": "optional", + "name": "SourceMask", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that privacy masks are only supported at the video source level and not the video source configuration level. \n\t\t\t\t\t\t\tIf this is true any addition, deletion or change of a privacy mask done for one video source configuration will automatically be \n\t\t\t\t\t\t\tapplied by the device to a corresponding privacy mask for all other video source configuration associated with the same video source." + }, + { + "use": "optional", + "name": "WebRTC", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Indicates number of supported WebRTC configurations." + }, + { + "use": "optional", + "name": "WebRTC_codecs", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported video and audio media types as defined by IANA. E.g. \"video/H264 audio/opus\"." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the media service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "CreateProfile", + "port_type": "Media2", + "description": "This operation creates a new media profile. A created profile created via this method may be deleted via the DeleteProfile method. Optionally Configurations can be assinged to the profile on creation. For details regarding profile assignement check also the method AddConfiguration.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}CreateProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}CreateProfile", + "schema": { + "name": "CreateProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "friendly name of the profile to be created" + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver20/media/wsdl}ConfigurationRef", + "type_name": "ConfigurationRef", + "definition": { + "kind": "complexType", + "name": "ConfigurationRef", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of the configuration as defined by tr2:ConfigurationEnumeration." + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Reference token of an existing configuration.\n\t\t\t\t\t\t\tToken shall be included in the AddConfiguration request along with the type.\n\t\t\t\t\t\t\tToken shall be included in the CreateProfile request when Configuration elements are included and type is selected.\n\t\t\t\t\t\t\tToken is optional for RemoveConfiguration request. If no token is provided in RemoveConfiguration request, device shall\n\t\t\t\t\t\t\tremove the configuration of the type included in the profile." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional set of configurations to be assigned to the profile. List entries with tr2:ConfigurationEnumeration value \"All\" shall be ignored." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}CreateProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}CreateProfileResponse", + "schema": { + "name": "CreateProfileResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token assigned by the device for the newly created profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetProfiles", + "port_type": "Media2", + "description": "Retrieve the profile with the specified token or all defined media profiles. If no Type is provided the returned profiles shall contain no configuration information. If a single Type with value 'All' is provided the returned profiles shall include all associated configurations. Otherwise the requested list of configurations shall for each profile include the configurations present as Type.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetProfilesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetProfiles", + "schema": { + "name": "GetProfiles", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional token of the requested profile." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The types shall be provided as defined by tr2:ConfigurationEnumeration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetProfilesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetProfilesResponse", + "schema": { + "name": "GetProfilesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Profiles", + "type": "{http://www.onvif.org/ver20/media/wsdl}MediaProfile", + "type_name": "MediaProfile", + "definition": { + "kind": "complexType", + "name": "MediaProfile", + "description": "A media profile consists of a set of media configurations.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name of the profile." + }, + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver20/media/wsdl}ConfigurationSet", + "type_name": "ConfigurationSet", + "definition": { + "kind": "complexType", + "name": "ConfigurationSet", + "description": "A set of media configurations.", + "fields": [ + { + "name": "VideoSource", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfiguration", + "type_name": "VideoSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the physical input." + }, + { + "name": "Bounds", + "type": "{http://www.onvif.org/ver10/schema}IntRectangle", + "type_name": "IntRectangle", + "definition": { + "kind": "complexType", + "name": "IntRectangle", + "description": "Rectangle defined by lower left corner position and size. Units are pixel.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "width", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "height", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension", + "type_name": "VideoSourceConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}Rotate", + "type_name": "Rotate", + "definition": { + "kind": "complexType", + "name": "Rotate", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Rotation feature." + }, + { + "name": "Degree", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateExtension", + "type_name": "RotateExtension", + "definition": { + "kind": "complexType", + "name": "RotateExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
\n\t\t\t\twhen Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rotation of captured image.\n\t\t\t\t\t\tWhat resolutions a device supports shall be unaffected by the Rotate parameters.
\n\t\t\t\t\t\tIf a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
\n\t\t\t\t\t\tThe device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition:\n\t\t\t\t\t\tif Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension2", + "type_name": "VideoSourceConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension2", + "fields": [ + { + "name": "LensDescription", + "type": "{http://www.onvif.org/ver10/schema}LensDescription", + "type_name": "LensDescription", + "definition": { + "kind": "complexType", + "name": "LensDescription", + "fields": [ + { + "name": "Offset", + "type": "{http://www.onvif.org/ver10/schema}LensOffset", + "type_name": "LensOffset", + "definition": { + "kind": "complexType", + "name": "LensOffset", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional horizontal offset of the lens center in normalized coordinates." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional vertical offset of the lens center in normalized coordinates." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Offset of the lens center to the imager center in normalized coordinates." + }, + { + "name": "Projection", + "type": "{http://www.onvif.org/ver10/schema}LensProjection", + "type_name": "LensProjection", + "definition": { + "kind": "complexType", + "name": "LensProjection", + "fields": [ + { + "name": "Angle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Angle of incidence." + }, + { + "name": "Radius", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mapping radius as a consequence of the emergent angle." + }, + { + "name": "Transmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ray absorption at the given angle due to vignetting. A value of one means no absorption." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation\n\t\t\t\t\tover the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius.\n\t\t\t\t\tItems outside the last projection Radius shall be assumed to be invisible (black)." + }, + { + "name": "XFactor", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Compensation of the x coordinate needed for the ONVIF normalized coordinate system." + } + ], + "attributes": [ + { + "use": "optional", + "name": "FocalLength", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional focal length of the optical system." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional element describing the geometric lens distortion. Multiple instances for future variable lens support." + }, + { + "name": "SceneOrientation", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientation", + "type_name": "SceneOrientation", + "definition": { + "kind": "complexType", + "name": "SceneOrientation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to assign the way the camera determines the scene orientation." + }, + { + "name": "Orientation", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field\n\t\t\t\t\t\tis optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required\n\t\t\t\t\t\tand the device will return an InvalidArgs fault if missing." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element describing the scene orientation in the camera's field of view." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "ViewMode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Video input." + }, + { + "name": "AudioSource", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfiguration", + "type_name": "AudioSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Audio Source the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio input." + }, + { + "name": "VideoEncoder", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoder2Configuration", + "type_name": "VideoEncoder2Configuration", + "definition": { + "kind": "complexType", + "name": "VideoEncoder2Configuration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and IANA Media Types." + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution2", + "type_name": "VideoResolution2", + "definition": { + "kind": "complexType", + "name": "VideoResolution2", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl2", + "type_name": "VideoRateControl2", + "definition": { + "kind": "complexType", + "name": "VideoRateControl2", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Desired frame rate in fps. The actual rate may be lower due to e.g. performance limitations." + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the maximum output bitrate in kbps" + }, + { + "name": "AverageBitRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The target average output bitrate in kbps. If this parameter is set to 0, AverageBitRate shall be ignored." + } + ], + "attributes": [ + { + "use": "optional", + "name": "ConstantBitRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Enforce constant bitrate." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "use": "optional", + "name": "AnchorFrameDistance", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Distance between anchor frames of type I-Frame and P-Frame. '1' indicates no B-Frames, '2' indicates that every 2nd frame is encoded as B-Frame, '3' indicates a structure like IBBPBBP..., etc." + }, + { + "use": "optional", + "name": "Profile", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The encoder profile as defined in tt:VideoEncodingProfiles." + }, + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + }, + { + "use": "optional", + "name": "Signed", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates if this stream will be signed according to the Media Signing Specification." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Defines the cryptographic algorithm to use as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Video encoder." + }, + { + "name": "AudioEncoder", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoder2Configuration", + "type_name": "AudioEncoder2Configuration", + "definition": { + "kind": "complexType", + "name": "AudioEncoder2Configuration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and IANA Media Types." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional multicast configuration of the audio stream." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + } + ], + "attributes": [ + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Defines the cryptographic algorithm to use as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio encoder." + }, + { + "name": "Analytics", + "type": "{http://www.onvif.org/ver10/schema}VideoAnalyticsConfiguration", + "type_name": "VideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoAnalyticsConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfiguration", + "type_name": "RuleEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfiguration", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfigurationExtension", + "type_name": "RuleEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the analytics module and rule engine." + }, + { + "name": "PTZ", + "type": "{http://www.onvif.org/ver10/schema}PTZConfiguration", + "type_name": "PTZConfiguration", + "definition": { + "kind": "complexType", + "name": "PTZConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "NodeToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A mandatory reference to the PTZ Node that the PTZ Configuration belongs to." + }, + { + "name": "DefaultAbsolutePantTiltPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default." + }, + { + "name": "DefaultAbsoluteZoomPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default." + }, + { + "name": "DefaultRelativePanTiltTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default." + }, + { + "name": "DefaultRelativeZoomTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default." + }, + { + "name": "DefaultContinuousPanTiltVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default." + }, + { + "name": "DefaultContinuousZoomVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default." + }, + { + "name": "DefaultPTZSpeed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds." + }, + { + "name": "DefaultPTZTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops." + }, + { + "name": "PanTiltLimits", + "type": "{http://www.onvif.org/ver10/schema}PanTiltLimits", + "type_name": "PanTiltLimits", + "definition": { + "kind": "complexType", + "name": "PanTiltLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of pan tilt limits." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Pan/Tilt limits element should be present for a PTZ Node that supports an absolute Pan/Tilt. If the element is present it signals the support for configurable Pan/Tilt limits. If limits are enabled, the Pan/Tilt movements shall always stay within the specified range. The Pan/Tilt limits are disabled by setting the limits to -INF or +INF." + }, + { + "name": "ZoomLimits", + "type": "{http://www.onvif.org/ver10/schema}ZoomLimits", + "type_name": "ZoomLimits", + "definition": { + "kind": "complexType", + "name": "ZoomLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of zoom limit" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Zoom limits element should be present for a PTZ Node that supports absolute zoom. If the element is present it signals the supports for configurable Zoom limits. If limits are enabled the zoom movements shall always stay within the specified range. The Zoom limits are disabled by settings the limits to -INF and +INF." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension", + "type_name": "PTZConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension", + "fields": [ + { + "name": "PTControlDirection", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirection", + "type_name": "PTControlDirection", + "definition": { + "kind": "complexType", + "name": "PTControlDirection", + "fields": [ + { + "name": "EFlip", + "type": "{http://www.onvif.org/ver10/schema}EFlip", + "type_name": "EFlip", + "definition": { + "kind": "complexType", + "name": "EFlip", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}EFlipMode", + "type_name": "EFlipMode", + "definition": { + "kind": "simpleType", + "name": "EFlipMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable E-Flip feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for E-Flip." + }, + { + "name": "Reverse", + "type": "{http://www.onvif.org/ver10/schema}Reverse", + "type_name": "Reverse", + "definition": { + "kind": "complexType", + "name": "Reverse", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReverseMode", + "type_name": "ReverseMode", + "definition": { + "kind": "simpleType", + "name": "ReverseMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "AUTO" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Reverse feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for reversing of PT Control Direction." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirectionExtension", + "type_name": "PTControlDirectionExtension", + "definition": { + "kind": "complexType", + "name": "PTControlDirectionExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure PT Control Direction related features." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension2", + "type_name": "PTZConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "MoveRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when moving." + }, + { + "use": "optional", + "name": "PresetRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when recalling presets." + }, + { + "use": "optional", + "name": "PresetTourRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when executing PresetTours." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the pan tilt zoom unit." + }, + { + "name": "Metadata", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfiguration", + "type_name": "MetadataConfiguration", + "definition": { + "kind": "complexType", + "name": "MetadataConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "PTZStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZFilter", + "type_name": "PTZFilter", + "definition": { + "kind": "complexType", + "name": "PTZFilter", + "fields": [ + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN)." + }, + { + "name": "Position", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ position." + }, + { + "name": "FieldOfView", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the field-of-view information." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which PTZ related data is to include in the metadata stream." + }, + { + "name": "Events", + "type": "{http://www.onvif.org/ver10/schema}EventSubscription", + "type_name": "EventSubscription", + "definition": { + "kind": "complexType", + "name": "EventSubscription", + "description": "Subscription handling in the same way as base notification subscription.", + "fields": [ + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure the streaming of events. A client might be interested in receiving all,\n\t\t\t\t\t\t\t\tnone or some of the events produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all events: Include the Events element but do not include a filter.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no events: Do not include the Events element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some events: Include the Events element and include a filter in the element.
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Analytics", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)" + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored)" + }, + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indication which AnalyticsModules shall output metadata.\n\t\t\t\t\t\t\tNote that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration." + }, + { + "name": "SensorData", + "type": "{http://www.onvif.org/ver10/schema}SensorDataFilter", + "type_name": "SensorDataFilter", + "definition": { + "kind": "complexType", + "name": "SensorDataFilter", + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:\n\t\t\t\t
    \n\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t
", + "fields": [ + { + "name": "SensorID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them)." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, \n\t\t\t\t\t\t\t\tnone or some of the sensor data produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationExtension", + "type_name": "MetadataConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "CompressionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType." + }, + { + "use": "optional", + "name": "GeoLocation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target." + }, + { + "use": "optional", + "name": "ShapePolygon", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the generated metadata stream should contain shape information as polygon." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the metadata stream." + }, + { + "name": "AudioOutput", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfiguration", + "type_name": "AudioOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio output." + }, + { + "name": "SendPrimacy", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\t\t\tneeds to be switched.\n\t\t\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio output." + }, + { + "name": "AudioDecoder", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfiguration", + "type_name": "AudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfiguration", + "description": "The Audio Decoder Configuration does not contain any that parameter to configure the\ndecoding .A decoder shall decode every data it receives (according to its capabilities).", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Audio decoder." + }, + { + "name": "Receiver", + "type": "{http://www.onvif.org/ver20/media/wsdl}ReceiverConfiguration", + "type_name": "ReceiverConfiguration", + "definition": { + "kind": "complexType", + "name": "ReceiverConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ReceiverConfiguration", + "base_definition": { + "kind": "complexType", + "name": "ReceiverConfiguration", + "description": "Describes the configuration of a receiver.", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReceiverMode", + "type_name": "ReceiverMode", + "definition": { + "kind": "simpleType", + "name": "ReceiverMode", + "description": "Specifies a receiver connection mode.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "AutoConnect", + "description": "The receiver connects on demand, as required by consumers of the media streams." + }, + { + "value": "AlwaysConnect", + "description": "The receiver attempts to maintain a persistent connection to the configured endpoint." + }, + { + "value": "NeverConnect", + "description": "The receiver does not attempt to connect." + }, + { + "value": "Unknown", + "description": "This case should never happen." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The following connection modes are defined:" + }, + { + "name": "MediaUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Details of the URI to which the receiver should connect." + }, + { + "name": "StreamSetup", + "type": "{http://www.onvif.org/ver10/schema}StreamSetup", + "type_name": "StreamSetup", + "definition": { + "kind": "complexType", + "name": "StreamSetup", + "fields": [ + { + "name": "Stream", + "type": "{http://www.onvif.org/ver10/schema}StreamType", + "type_name": "StreamType", + "definition": { + "kind": "simpleType", + "name": "StreamType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "RTP-Unicast" + }, + { + "value": "RTP-Multicast" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines if a multicast or unicast stream is requested." + }, + { + "name": "Transport", + "type": "{http://www.onvif.org/ver10/schema}Transport", + "type_name": "Transport", + "definition": { + "kind": "complexType", + "name": "Transport", + "fields": [ + { + "name": "Protocol", + "type": "{http://www.onvif.org/ver10/schema}TransportProtocol", + "type_name": "TransportProtocol", + "definition": { + "kind": "simpleType", + "name": "TransportProtocol", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "UDP" + }, + { + "value": "TCP", + "description": "This value is deprecated." + }, + { + "value": "RTSP" + }, + { + "value": "HTTP" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP." + }, + { + "name": "Tunnel", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Deprecated: optional element to describe further tunnel options." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Stream connection parameters." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration of the Receiver." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The configurations assigned to the profile." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of the profile." + }, + { + "use": "optional", + "name": "fixed", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true signals that the profile cannot be deleted. Default is false." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Lists all profiles that exist in the media service. The response provides the requested types of Configurations as far as available. \n\t\t\t\t\t\t\t\t\tIf a profile doesn't contain a type no error shall be provided." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "AddConfiguration", + "port_type": "Media2", + "description": "This operation adds one or more Configurations to an existing media profile. If a configuration exists in the media profile, it will be replaced. A device shall support adding a compatible Configuration to a Profile containing a VideoSourceConfiguration and shall support streaming video data of such a profile. Note that OSD elements must be added via the CreateOSD command.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}AddConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}AddConfiguration", + "schema": { + "name": "AddConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the profile where the configuration should be added" + }, + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional item. If present updates the Name property of the profile." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver20/media/wsdl}ConfigurationRef", + "type_name": "ConfigurationRef", + "definition": { + "kind": "complexType", + "name": "ConfigurationRef", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of the configuration as defined by tr2:ConfigurationEnumeration." + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Reference token of an existing configuration.\n\t\t\t\t\t\t\tToken shall be included in the AddConfiguration request along with the type.\n\t\t\t\t\t\t\tToken shall be included in the CreateProfile request when Configuration elements are included and type is selected.\n\t\t\t\t\t\t\tToken is optional for RemoveConfiguration request. If no token is provided in RemoveConfiguration request, device shall\n\t\t\t\t\t\t\tremove the configuration of the type included in the profile." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of configurations to be added. The types shall be provided in the order defined by tr2:ConfigurationEnumeration. List entries with tr2:ConfigurationEnumeration value \"All\" shall be ignored." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}AddConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}AddConfigurationResponse", + "schema": { + "name": "AddConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "RemoveConfiguration", + "port_type": "Media2", + "description": "This operation removes the listed configurations from an existing media profile. If the media profile does not contain one of the listed configurations that item shall be ignored.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}RemoveConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}RemoveConfiguration", + "schema": { + "name": "RemoveConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This element contains a reference to the media profile from which the configuration shall be removed." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver20/media/wsdl}ConfigurationRef", + "type_name": "ConfigurationRef", + "definition": { + "kind": "complexType", + "name": "ConfigurationRef", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of the configuration as defined by tr2:ConfigurationEnumeration." + }, + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Reference token of an existing configuration.\n\t\t\t\t\t\t\tToken shall be included in the AddConfiguration request along with the type.\n\t\t\t\t\t\t\tToken shall be included in the CreateProfile request when Configuration elements are included and type is selected.\n\t\t\t\t\t\t\tToken is optional for RemoveConfiguration request. If no token is provided in RemoveConfiguration request, device shall\n\t\t\t\t\t\t\tremove the configuration of the type included in the profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of configurations to be removed. The types shall be provided in the order defined by tr2:ConfigurationEnumeration. Tokens appearing in the configuration list shall be ignored. Presence of the \"All\" type shall result in an empty profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}RemoveConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}RemoveConfigurationResponse", + "schema": { + "name": "RemoveConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "DeleteProfile", + "port_type": "Media2", + "description": "This operation deletes a profile. Deletion of a profile is only possible for non-fixed profiles", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}DeleteProfileRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}DeleteProfile", + "schema": { + "name": "DeleteProfile", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This element contains a reference to the profile that should be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}DeleteProfileResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}DeleteProfileResponse", + "schema": { + "name": "DeleteProfileResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetVideoSourceConfigurations", + "port_type": "Media2", + "description": "By default this operation lists all existing video source configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetVideoSourceConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetVideoSourceConfigurations", + "schema": { + "name": "GetVideoSourceConfigurations", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetVideoSourceConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetVideoSourceConfigurationsResponse", + "schema": { + "name": "GetVideoSourceConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfiguration", + "type_name": "VideoSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the physical input." + }, + { + "name": "Bounds", + "type": "{http://www.onvif.org/ver10/schema}IntRectangle", + "type_name": "IntRectangle", + "definition": { + "kind": "complexType", + "name": "IntRectangle", + "description": "Rectangle defined by lower left corner position and size. Units are pixel.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "width", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "height", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension", + "type_name": "VideoSourceConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}Rotate", + "type_name": "Rotate", + "definition": { + "kind": "complexType", + "name": "Rotate", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Rotation feature." + }, + { + "name": "Degree", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateExtension", + "type_name": "RotateExtension", + "definition": { + "kind": "complexType", + "name": "RotateExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
\n\t\t\t\twhen Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rotation of captured image.\n\t\t\t\t\t\tWhat resolutions a device supports shall be unaffected by the Rotate parameters.
\n\t\t\t\t\t\tIf a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
\n\t\t\t\t\t\tThe device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition:\n\t\t\t\t\t\tif Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension2", + "type_name": "VideoSourceConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension2", + "fields": [ + { + "name": "LensDescription", + "type": "{http://www.onvif.org/ver10/schema}LensDescription", + "type_name": "LensDescription", + "definition": { + "kind": "complexType", + "name": "LensDescription", + "fields": [ + { + "name": "Offset", + "type": "{http://www.onvif.org/ver10/schema}LensOffset", + "type_name": "LensOffset", + "definition": { + "kind": "complexType", + "name": "LensOffset", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional horizontal offset of the lens center in normalized coordinates." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional vertical offset of the lens center in normalized coordinates." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Offset of the lens center to the imager center in normalized coordinates." + }, + { + "name": "Projection", + "type": "{http://www.onvif.org/ver10/schema}LensProjection", + "type_name": "LensProjection", + "definition": { + "kind": "complexType", + "name": "LensProjection", + "fields": [ + { + "name": "Angle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Angle of incidence." + }, + { + "name": "Radius", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mapping radius as a consequence of the emergent angle." + }, + { + "name": "Transmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ray absorption at the given angle due to vignetting. A value of one means no absorption." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation\n\t\t\t\t\tover the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius.\n\t\t\t\t\tItems outside the last projection Radius shall be assumed to be invisible (black)." + }, + { + "name": "XFactor", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Compensation of the x coordinate needed for the ONVIF normalized coordinate system." + } + ], + "attributes": [ + { + "use": "optional", + "name": "FocalLength", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional focal length of the optical system." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional element describing the geometric lens distortion. Multiple instances for future variable lens support." + }, + { + "name": "SceneOrientation", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientation", + "type_name": "SceneOrientation", + "definition": { + "kind": "complexType", + "name": "SceneOrientation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to assign the way the camera determines the scene orientation." + }, + { + "name": "Orientation", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field\n\t\t\t\t\t\tis optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required\n\t\t\t\t\t\tand the device will return an InvalidArgs fault if missing." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element describing the scene orientation in the camera's field of view." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "ViewMode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of video source configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetVideoEncoderConfigurations", + "port_type": "Media2", + "description": "By default this operation lists all existing video encoder configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetVideoEncoderConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetVideoEncoderConfigurations", + "schema": { + "name": "GetVideoEncoderConfigurations", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetVideoEncoderConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetVideoEncoderConfigurationsResponse", + "schema": { + "name": "GetVideoEncoderConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoder2Configuration", + "type_name": "VideoEncoder2Configuration", + "definition": { + "kind": "complexType", + "name": "VideoEncoder2Configuration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and IANA Media Types." + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution2", + "type_name": "VideoResolution2", + "definition": { + "kind": "complexType", + "name": "VideoResolution2", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl2", + "type_name": "VideoRateControl2", + "definition": { + "kind": "complexType", + "name": "VideoRateControl2", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Desired frame rate in fps. The actual rate may be lower due to e.g. performance limitations." + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the maximum output bitrate in kbps" + }, + { + "name": "AverageBitRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The target average output bitrate in kbps. If this parameter is set to 0, AverageBitRate shall be ignored." + } + ], + "attributes": [ + { + "use": "optional", + "name": "ConstantBitRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Enforce constant bitrate." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "use": "optional", + "name": "AnchorFrameDistance", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Distance between anchor frames of type I-Frame and P-Frame. '1' indicates no B-Frames, '2' indicates that every 2nd frame is encoded as B-Frame, '3' indicates a structure like IBBPBBP..., etc." + }, + { + "use": "optional", + "name": "Profile", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The encoder profile as defined in tt:VideoEncodingProfiles." + }, + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + }, + { + "use": "optional", + "name": "Signed", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates if this stream will be signed according to the Media Signing Specification." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Defines the cryptographic algorithm to use as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of video encoder configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetAudioSourceConfigurations", + "port_type": "Media2", + "description": "By default this operation lists all existing audio source configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioSourceConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioSourceConfigurations", + "schema": { + "name": "GetAudioSourceConfigurations", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioSourceConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioSourceConfigurationsResponse", + "schema": { + "name": "GetAudioSourceConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfiguration", + "type_name": "AudioSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Audio Source the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of audio source configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetAudioEncoderConfigurations", + "port_type": "Media2", + "description": "By default this operation lists all existing audio encoder configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioEncoderConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioEncoderConfigurations", + "schema": { + "name": "GetAudioEncoderConfigurations", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioEncoderConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioEncoderConfigurationsResponse", + "schema": { + "name": "GetAudioEncoderConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoder2Configuration", + "type_name": "AudioEncoder2Configuration", + "definition": { + "kind": "complexType", + "name": "AudioEncoder2Configuration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and IANA Media Types." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional multicast configuration of the audio stream." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + } + ], + "attributes": [ + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Defines the cryptographic algorithm to use as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of audio encoder configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetAnalyticsConfigurations", + "port_type": "Media2", + "description": "By default this operation lists all existing video analytics configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAnalyticsConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAnalyticsConfigurations", + "schema": { + "name": "GetAnalyticsConfigurations", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAnalyticsConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAnalyticsConfigurationsResponse", + "schema": { + "name": "GetAnalyticsConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}VideoAnalyticsConfiguration", + "type_name": "VideoAnalyticsConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoAnalyticsConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "RuleEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfiguration", + "type_name": "RuleEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfiguration", + "fields": [ + { + "name": "Rule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RuleEngineConfigurationExtension", + "type_name": "RuleEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "RuleEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of Analytics configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetMetadataConfigurations", + "port_type": "Media2", + "description": "By default this operation lists all existing metadata configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetMetadataConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetMetadataConfigurations", + "schema": { + "name": "GetMetadataConfigurations", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetMetadataConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetMetadataConfigurationsResponse", + "schema": { + "name": "GetMetadataConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfiguration", + "type_name": "MetadataConfiguration", + "definition": { + "kind": "complexType", + "name": "MetadataConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "PTZStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZFilter", + "type_name": "PTZFilter", + "definition": { + "kind": "complexType", + "name": "PTZFilter", + "fields": [ + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN)." + }, + { + "name": "Position", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ position." + }, + { + "name": "FieldOfView", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the field-of-view information." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which PTZ related data is to include in the metadata stream." + }, + { + "name": "Events", + "type": "{http://www.onvif.org/ver10/schema}EventSubscription", + "type_name": "EventSubscription", + "definition": { + "kind": "complexType", + "name": "EventSubscription", + "description": "Subscription handling in the same way as base notification subscription.", + "fields": [ + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure the streaming of events. A client might be interested in receiving all,\n\t\t\t\t\t\t\t\tnone or some of the events produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all events: Include the Events element but do not include a filter.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no events: Do not include the Events element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some events: Include the Events element and include a filter in the element.
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Analytics", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)" + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored)" + }, + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indication which AnalyticsModules shall output metadata.\n\t\t\t\t\t\t\tNote that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration." + }, + { + "name": "SensorData", + "type": "{http://www.onvif.org/ver10/schema}SensorDataFilter", + "type_name": "SensorDataFilter", + "definition": { + "kind": "complexType", + "name": "SensorDataFilter", + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:\n\t\t\t\t
    \n\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t
", + "fields": [ + { + "name": "SensorID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them)." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, \n\t\t\t\t\t\t\t\tnone or some of the sensor data produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationExtension", + "type_name": "MetadataConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "CompressionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType." + }, + { + "use": "optional", + "name": "GeoLocation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target." + }, + { + "use": "optional", + "name": "ShapePolygon", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the generated metadata stream should contain shape information as polygon." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of metadata configurations" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetAudioOutputConfigurations", + "port_type": "Media2", + "description": "By default this operation lists all existing audio output configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioOutputConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioOutputConfigurations", + "schema": { + "name": "GetAudioOutputConfigurations", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioOutputConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioOutputConfigurationsResponse", + "schema": { + "name": "GetAudioOutputConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfiguration", + "type_name": "AudioOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio output." + }, + { + "name": "SendPrimacy", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\t\t\tneeds to be switched.\n\t\t\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of audio output configurations" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetAudioDecoderConfigurations", + "port_type": "Media2", + "description": "By default this operation lists all existing audio decoder configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioDecoderConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioDecoderConfigurations", + "schema": { + "name": "GetAudioDecoderConfigurations", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioDecoderConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioDecoderConfigurationsResponse", + "schema": { + "name": "GetAudioDecoderConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfiguration", + "type_name": "AudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfiguration", + "description": "The Audio Decoder Configuration does not contain any that parameter to configure the\ndecoding .A decoder shall decode every data it receives (according to its capabilities).", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of audio decoder configurations" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetVideoSourceConfiguration", + "port_type": "Media2", + "description": "This operation modifies a video source configuration. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream. NVC methods for changing a running stream are out of scope for this specification.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetVideoSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetVideoSourceConfiguration", + "schema": { + "name": "SetVideoSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfiguration", + "type_name": "VideoSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the physical input." + }, + { + "name": "Bounds", + "type": "{http://www.onvif.org/ver10/schema}IntRectangle", + "type_name": "IntRectangle", + "definition": { + "kind": "complexType", + "name": "IntRectangle", + "description": "Rectangle defined by lower left corner position and size. Units are pixel.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "width", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "required", + "name": "height", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension", + "type_name": "VideoSourceConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}Rotate", + "type_name": "Rotate", + "definition": { + "kind": "complexType", + "name": "Rotate", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Rotation feature." + }, + { + "name": "Degree", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateExtension", + "type_name": "RotateExtension", + "definition": { + "kind": "complexType", + "name": "RotateExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
\n\t\t\t\twhen Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rotation of captured image.\n\t\t\t\t\t\tWhat resolutions a device supports shall be unaffected by the Rotate parameters.
\n\t\t\t\t\t\tIf a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
\n\t\t\t\t\t\tThe device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition:\n\t\t\t\t\t\tif Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationExtension2", + "type_name": "VideoSourceConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationExtension2", + "fields": [ + { + "name": "LensDescription", + "type": "{http://www.onvif.org/ver10/schema}LensDescription", + "type_name": "LensDescription", + "definition": { + "kind": "complexType", + "name": "LensDescription", + "fields": [ + { + "name": "Offset", + "type": "{http://www.onvif.org/ver10/schema}LensOffset", + "type_name": "LensOffset", + "definition": { + "kind": "complexType", + "name": "LensOffset", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional horizontal offset of the lens center in normalized coordinates." + }, + { + "use": "optional", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional vertical offset of the lens center in normalized coordinates." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Offset of the lens center to the imager center in normalized coordinates." + }, + { + "name": "Projection", + "type": "{http://www.onvif.org/ver10/schema}LensProjection", + "type_name": "LensProjection", + "definition": { + "kind": "complexType", + "name": "LensProjection", + "fields": [ + { + "name": "Angle", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Angle of incidence." + }, + { + "name": "Radius", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mapping radius as a consequence of the emergent angle." + }, + { + "name": "Transmittance", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional ray absorption at the given angle due to vignetting. A value of one means no absorption." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation\n\t\t\t\t\tover the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius.\n\t\t\t\t\tItems outside the last projection Radius shall be assumed to be invisible (black)." + }, + { + "name": "XFactor", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Compensation of the x coordinate needed for the ONVIF normalized coordinate system." + } + ], + "attributes": [ + { + "use": "optional", + "name": "FocalLength", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Optional focal length of the optical system." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional element describing the geometric lens distortion. Multiple instances for future variable lens support." + }, + { + "name": "SceneOrientation", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientation", + "type_name": "SceneOrientation", + "definition": { + "kind": "complexType", + "name": "SceneOrientation", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to assign the way the camera determines the scene orientation." + }, + { + "name": "Orientation", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field\n\t\t\t\t\t\tis optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required\n\t\t\t\t\t\tand the device will return an InvalidArgs fault if missing." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element describing the scene orientation in the camera's field of view." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "ViewMode", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified video source configuration. The configuration shall exist in the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetVideoSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetVideoSourceConfigurationResponse", + "schema": { + "name": "SetVideoSourceConfigurationResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetVideoEncoderConfiguration", + "port_type": "Media2", + "description": "This operation modifies a video encoder configuration. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream. NVC methods for changing a running stream are out of scope for this specification. SessionTimeout is provided as a hint for keeping rtsp session by a device. If necessary the device may adapt parameter values for SessionTimeout elements without returning an error. For the time between keep alive calls the client shall adhere to the timeout value signaled via RTSP.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetVideoEncoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetVideoEncoderConfiguration", + "schema": { + "name": "SetVideoEncoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoder2Configuration", + "type_name": "VideoEncoder2Configuration", + "definition": { + "kind": "complexType", + "name": "VideoEncoder2Configuration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and IANA Media Types." + }, + { + "name": "Resolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution2", + "type_name": "VideoResolution2", + "definition": { + "kind": "complexType", + "name": "VideoResolution2", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configured video resolution" + }, + { + "name": "RateControl", + "type": "{http://www.onvif.org/ver10/schema}VideoRateControl2", + "type_name": "VideoRateControl2", + "definition": { + "kind": "complexType", + "name": "VideoRateControl2", + "fields": [ + { + "name": "FrameRateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Desired frame rate in fps. The actual rate may be lower due to e.g. performance limitations." + }, + { + "name": "BitrateLimit", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "the maximum output bitrate in kbps" + }, + { + "name": "AverageBitRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The target average output bitrate in kbps. If this parameter is set to 0, AverageBitRate shall be ignored." + } + ], + "attributes": [ + { + "use": "optional", + "name": "ConstantBitRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Enforce constant bitrate." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure rate control related parameters." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "Quality", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality" + } + ], + "attributes": [ + { + "use": "optional", + "name": "GovLength", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames." + }, + { + "use": "optional", + "name": "AnchorFrameDistance", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Distance between anchor frames of type I-Frame and P-Frame. '1' indicates no B-Frames, '2' indicates that every 2nd frame is encoded as B-Frame, '3' indicates a structure like IBBPBBP..., etc." + }, + { + "use": "optional", + "name": "Profile", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The encoder profile as defined in tt:VideoEncodingProfiles." + }, + { + "use": "optional", + "name": "GuaranteedFrameRate", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "A value of true indicates that frame rate is a fixed value rather than an upper limit,\n\t\t\t\t\t\t\tand that the video encoder shall prioritize frame rate over all other adaptable\n\t\t\t\t\t\t\tconfiguration values such as bitrate. Default is false." + }, + { + "use": "optional", + "name": "Signed", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates if this stream will be signed according to the Media Signing Specification." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Defines the cryptographic algorithm to use as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified video encoder configuration. The configuration shall exist in the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetVideoEncoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetVideoEncoderConfigurationResponse", + "schema": { + "name": "SetVideoEncoderConfigurationResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetAudioSourceConfiguration", + "port_type": "Media2", + "description": "This operation modifies an audio source configuration. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream NVC methods for changing a running stream are out of scope for this specification.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetAudioSourceConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetAudioSourceConfiguration", + "schema": { + "name": "SetAudioSourceConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfiguration", + "type_name": "AudioSourceConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "SourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Audio Source the configuration applies to" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified audio source configuration. The configuration shall exist in the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetAudioSourceConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetAudioSourceConfigurationResponse", + "schema": { + "name": "SetAudioSourceConfigurationResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetAudioEncoderConfiguration", + "port_type": "Media2", + "description": "This operation modifies an audio encoder configuration. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected streams. NVC methods for changing a running stream are out of scope for this specification.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetAudioEncoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetAudioEncoderConfiguration", + "schema": { + "name": "SetAudioEncoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoder2Configuration", + "type_name": "AudioEncoder2Configuration", + "definition": { + "kind": "complexType", + "name": "AudioEncoder2Configuration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and IANA Media Types." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional multicast configuration of the audio stream." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output bitrate in kbps." + }, + { + "name": "SampleRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The output sample rate in kHz." + } + ], + "attributes": [ + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Defines the cryptographic algorithm to use as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified audio encoder configuration. The configuration shall exist in the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetAudioEncoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetAudioEncoderConfigurationResponse", + "schema": { + "name": "SetAudioEncoderConfigurationResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetMetadataConfiguration", + "port_type": "Media2", + "description": "This operation modifies a metadata configuration. Running streams using this configuration may be updated immediately according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected streams. NVC methods for changing a running stream are out of scope for this specification.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetMetadataConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetMetadataConfiguration", + "schema": { + "name": "SetMetadataConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfiguration", + "type_name": "MetadataConfiguration", + "definition": { + "kind": "complexType", + "name": "MetadataConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "PTZStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZFilter", + "type_name": "PTZFilter", + "definition": { + "kind": "complexType", + "name": "PTZFilter", + "fields": [ + { + "name": "Status", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN)." + }, + { + "name": "Position", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the PTZ position." + }, + { + "name": "FieldOfView", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the metadata stream shall contain the field-of-view information." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which PTZ related data is to include in the metadata stream." + }, + { + "name": "Events", + "type": "{http://www.onvif.org/ver10/schema}EventSubscription", + "type_name": "EventSubscription", + "definition": { + "kind": "complexType", + "name": "EventSubscription", + "description": "Subscription handling in the same way as base notification subscription.", + "fields": [ + { + "name": "Filter", + "type": "{http://docs.oasis-open.org/wsn/b-2}FilterType", + "type_name": "FilterType", + "definition": { + "kind": "complexType", + "name": "FilterType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "strict", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SubscriptionPolicy", + "definition": { + "kind": "complexType", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure the streaming of events. A client might be interested in receiving all,\n\t\t\t\t\t\t\t\tnone or some of the events produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all events: Include the Events element but do not include a filter.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no events: Do not include the Events element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some events: Include the Events element and include a filter in the element.
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Analytics", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)" + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastConfiguration", + "type_name": "MulticastConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the multicast settings that could be used for video streaming." + }, + { + "name": "SessionTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored)" + }, + { + "name": "AnalyticsEngineConfiguration", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfiguration", + "type_name": "AnalyticsEngineConfiguration", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfiguration", + "fields": [ + { + "name": "AnalyticsModule", + "type": "{http://www.onvif.org/ver10/schema}Config", + "type_name": "Config", + "definition": { + "kind": "complexType", + "name": "Config", + "fields": [ + { + "name": "Parameters", + "type": "{http://www.onvif.org/ver10/schema}ItemList", + "type_name": "ItemList", + "definition": { + "kind": "complexType", + "name": "ItemList", + "fields": [ + { + "name": "SimpleItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Value name pair as defined by the corresponding description." + }, + { + "name": "ElementItem", + "definition": { + "kind": "complexType", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Complex value structure." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ItemListExtension", + "type_name": "ItemListExtension", + "definition": { + "kind": "complexType", + "name": "ItemListExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + }, + { + "use": "required", + "name": "Value", + "type": "{http://www.w3.org/2001/XMLSchema}anySimpleType", + "description": "Item value. The type is defined in the corresponding description." + }, + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Item name." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 1, + "max_occurs": 1 + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of configuration parameters as defined in the corresponding description." + } + ], + "attributes": [ + { + "use": "required", + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Name of the configuration." + }, + { + "use": "required", + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}QName", + "description": "The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AnalyticsEngineConfigurationExtension", + "type_name": "AnalyticsEngineConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "AnalyticsEngineConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indication which AnalyticsModules shall output metadata.\n\t\t\t\t\t\t\tNote that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration." + }, + { + "name": "SensorData", + "type": "{http://www.onvif.org/ver10/schema}SensorDataFilter", + "type_name": "SensorDataFilter", + "definition": { + "kind": "complexType", + "name": "SensorDataFilter", + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:\n\t\t\t\t
    \n\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t
", + "fields": [ + { + "name": "SensorID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them)." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, \n\t\t\t\t\t\t\t\tnone or some of the sensor data produced by the device:
    \n\t\t\t\t\t\t\t\t\t
  • To get all sensor data: Include the SensorData element but do not include any filter criteria.
    • \n\t\t\t\t\t\t\t\t\t
  • To get no sensor data: Do not include the SensorData element.
    • \n\t\t\t\t\t\t\t\t\t
  • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
    • \n\t\t\t\t\t\t\t\t
" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationExtension", + "type_name": "MetadataConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "CompressionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType." + }, + { + "use": "optional", + "name": "GeoLocation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target." + }, + { + "use": "optional", + "name": "ShapePolygon", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Optional parameter to configure if the generated metadata stream should contain shape information as polygon." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms" + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified metadata configuration. The configuration shall exist in the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetMetadataConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetMetadataConfigurationResponse", + "schema": { + "name": "SetMetadataConfigurationResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetAudioOutputConfiguration", + "port_type": "Media2", + "description": "This operation modifies an audio output configuration.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetAudioOutputConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetAudioOutputConfiguration", + "schema": { + "name": "SetAudioOutputConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfiguration", + "type_name": "AudioOutputConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "OutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the physical Audio output." + }, + { + "name": "SendPrimacy", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\t\t\tneeds to be switched.\n\t\t\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified audio output configuration. The configuration shall exist in the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetAudioOutputConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetAudioOutputConfigurationResponse", + "schema": { + "name": "SetAudioOutputConfigurationResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetAudioDecoderConfiguration", + "port_type": "Media2", + "description": "This operation modifies an audio decoder configuration.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetAudioDecoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetAudioDecoderConfiguration", + "schema": { + "name": "SetAudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoderConfiguration", + "type_name": "AudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "name": "AudioDecoderConfiguration", + "description": "The Audio Decoder Configuration does not contain any that parameter to configure the\ndecoding .A decoder shall decode every data it receives (according to its capabilities).", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified audio decoder configuration. The configuration shall exist in the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetAudioDecoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetAudioDecoderConfigurationResponse", + "schema": { + "name": "SetAudioDecoderConfigurationResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetVideoSourceConfigurationOptions", + "port_type": "Media2", + "description": "This operation returns the available options (supported values and ranges for video source configuration parameters) when the video source parameters are reconfigured If a video source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetVideoSourceConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetVideoSourceConfigurationOptions", + "schema": { + "name": "GetVideoSourceConfigurationOptions", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetVideoSourceConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetVideoSourceConfigurationOptionsResponse", + "schema": { + "name": "GetVideoSourceConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationOptions", + "type_name": "VideoSourceConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationOptions", + "fields": [ + { + "name": "BoundsRange", + "type": "{http://www.onvif.org/ver10/schema}IntRectangleRange", + "type_name": "IntRectangleRange", + "definition": { + "kind": "complexType", + "name": "IntRectangleRange", + "description": "Range of a rectangle. The rectangle itself is defined by lower left corner position and size. Units are pixel.", + "fields": [ + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of X-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of Y-axis." + }, + { + "name": "WidthRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of width." + }, + { + "name": "HeightRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of height." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported range for the capturing area.\n\t\t\t\t\t\tDevice that does not support cropped streaming shall express BoundsRange option as mentioned below\n\t\t\t\t\t\tBoundsRange->XRange and BoundsRange->YRange with same Min/Max values HeightRange and WidthRange Min/Max values same as VideoSource Height and Width Limits." + }, + { + "name": "VideoSourceTokensAvailable", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of physical inputs." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationOptionsExtension", + "type_name": "VideoSourceConfigurationOptionsExtension", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationOptionsExtension", + "fields": [ + { + "name": "Rotate", + "type": "{http://www.onvif.org/ver10/schema}RotateOptions", + "type_name": "RotateOptions", + "definition": { + "kind": "complexType", + "name": "RotateOptions", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}RotateMode", + "type_name": "RotateMode", + "definition": { + "kind": "simpleType", + "name": "RotateMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF", + "description": "Enable the Rotate feature. Degree of rotation is specified Degree parameter." + }, + { + "value": "ON", + "description": "Disable the Rotate feature." + }, + { + "value": "AUTO", + "description": "Rotate feature is automatically activated by the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Supported options of Rotate mode parameter." + }, + { + "name": "DegreeList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported degree value for rotation." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}RotateOptionsExtension", + "type_name": "RotateOptionsExtension", + "definition": { + "kind": "complexType", + "name": "RotateOptionsExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Reboot", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Signals if a device requires a reboot after changing the rotation or mirror.\n\t\t\t\tIf a device can handle rotation changes or mirror changes without rebooting this value shall be set to false." + }, + { + "use": "optional", + "name": "Mirror", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Signals if video source mirroring is supported." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Options of parameters for Rotation feature." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}VideoSourceConfigurationOptionsExtension2", + "type_name": "VideoSourceConfigurationOptionsExtension2", + "definition": { + "kind": "complexType", + "name": "VideoSourceConfigurationOptionsExtension2", + "fields": [ + { + "name": "SceneOrientationMode", + "type": "{http://www.onvif.org/ver10/schema}SceneOrientationMode", + "type_name": "SceneOrientationMode", + "definition": { + "kind": "simpleType", + "name": "SceneOrientationMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "MANUAL" + }, + { + "value": "AUTO" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Scene orientation modes supported by the device for this configuration." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "MaximumNumberOfProfiles", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Maximum number of profiles." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This message contains the video source configuration options. If a video source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetVideoEncoderConfigurationOptions", + "port_type": "Media2", + "description": "This operation returns the available options (supported values and ranges for video encoder configuration parameters) when the video encoder parameters are reconfigured. This response contains the available video encoder configuration options. If a video encoder configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetVideoEncoderConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetVideoEncoderConfigurationOptions", + "schema": { + "name": "GetVideoEncoderConfigurationOptions", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetVideoEncoderConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetVideoEncoderConfigurationOptionsResponse", + "schema": { + "name": "GetVideoEncoderConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}VideoEncoder2ConfigurationOptions", + "type_name": "VideoEncoder2ConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "VideoEncoder2ConfigurationOptions", + "fields": [ + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and IANA Media Types." + }, + { + "name": "QualityRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Range of the quality values. A high value means higher quality." + }, + { + "name": "ResolutionsAvailable", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution2", + "type_name": "VideoResolution2", + "definition": { + "kind": "complexType", + "name": "VideoResolution2", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported image sizes." + }, + { + "name": "BitrateRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported range of encoded bitrate in kbps." + } + ], + "attributes": [ + { + "use": "optional", + "name": "GovLengthRange", + "type": "{http://www.onvif.org/ver10/schema}IntList", + "definition": { + "kind": "simpleType", + "name": "IntList", + "item_type": "{http://www.w3.org/2001/XMLSchema}int" + }, + "description": "Exactly two values, which define the Lower and Upper bounds for the supported group of Video frames length. These values typically correspond to the I-Frame distance." + }, + { + "use": "optional", + "name": "MaxAnchorFrameDistance", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "Signals support for B-Frames. Upper bound for the supported anchor frame distance (must be larger than one)." + }, + { + "use": "optional", + "name": "FrameRatesSupported", + "type": "{http://www.onvif.org/ver10/schema}FloatList", + "definition": { + "kind": "simpleType", + "name": "FloatList", + "item_type": "{http://www.w3.org/2001/XMLSchema}float" + }, + "description": "List of supported target frame rates in fps (frames per second). The list shall be sorted with highest values first." + }, + { + "use": "optional", + "name": "ProfilesSupported", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported encoder profiles as defined in tt::VideoEncodingProfiles." + }, + { + "use": "optional", + "name": "ConstantBitRateSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Signal whether enforcing constant bitrate is supported." + }, + { + "use": "optional", + "name": "AverageBitRateSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Signal whether enforcing average bitrate is supported." + }, + { + "use": "optional", + "name": "GuaranteedFrameRateSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoder2Configuration element." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithms", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "If secure RTSP streaming is supported, this shall return the list of supported cryptographic algorithms as defined by tt:SrtpSecurityAlgorithms." + }, + { + "use": "optional", + "name": "SigningSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates the support for signing according to the Media Signing Specification." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetAudioSourceConfigurationOptions", + "port_type": "Media2", + "description": "This operation returns the available options (supported values and ranges for audio source configuration parameters) when the audio source parameters are reconfigured. If an audio source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioSourceConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioSourceConfigurationOptions", + "schema": { + "name": "GetAudioSourceConfigurationOptions", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioSourceConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioSourceConfigurationOptionsResponse", + "schema": { + "name": "GetAudioSourceConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceConfigurationOptions", + "type_name": "AudioSourceConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioSourceConfigurationOptions", + "fields": [ + { + "name": "InputTokensAvailable", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the audio source the configuration can be used for." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}AudioSourceOptionsExtension", + "type_name": "AudioSourceOptionsExtension", + "definition": { + "kind": "complexType", + "name": "AudioSourceOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This message contains the audio source configuration options. If a audio source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetAudioEncoderConfigurationOptions", + "port_type": "Media2", + "description": "This operation returns the available options (supported values and ranges for audio encoder configuration parameters) when the audio encoder parameters are reconfigured.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioEncoderConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioEncoderConfigurationOptions", + "schema": { + "name": "GetAudioEncoderConfigurationOptions", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioEncoderConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioEncoderConfigurationOptionsResponse", + "schema": { + "name": "GetAudioEncoderConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoder2ConfigurationOptions", + "type_name": "AudioEncoder2ConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioEncoder2ConfigurationOptions", + "fields": [ + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and IANA Media Types." + }, + { + "name": "BitrateList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps for the specified Encoding." + }, + { + "name": "SampleRateList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported Sample Rates in kHz for the specified Encoding" + } + ], + "attributes": [ + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithms", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "If secure RTSP streaming is supported, this shall return the list of supported cryptographic algorithms as defined by tt:SrtpSecurityAlgorithms." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "This message contains the audio encoder configuration options. If a audio encoder configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetMetadataConfigurationOptions", + "port_type": "Media2", + "description": "This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetMetadataConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetMetadataConfigurationOptions", + "schema": { + "name": "GetMetadataConfigurationOptions", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetMetadataConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetMetadataConfigurationOptionsResponse", + "schema": { + "name": "GetMetadataConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationOptions", + "type_name": "MetadataConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationOptions", + "fields": [ + { + "name": "PTZStatusFilterOptions", + "type": "{http://www.onvif.org/ver10/schema}PTZStatusFilterOptions", + "type_name": "PTZStatusFilterOptions", + "definition": { + "kind": "complexType", + "name": "PTZStatusFilterOptions", + "fields": [ + { + "name": "PanTiltStatusSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the device is able to stream pan or tilt status information." + }, + { + "name": "ZoomStatusSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the device is able to stream zoom status information." + }, + { + "name": "PanTiltPositionSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the device is able to stream the pan or tilt position." + }, + { + "name": "ZoomPositionSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the device is able to stream zoom position information." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZStatusFilterOptionsExtension", + "type_name": "PTZStatusFilterOptionsExtension", + "definition": { + "kind": "complexType", + "name": "PTZStatusFilterOptionsExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "FieldOfViewSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "True if the device is able to stream the field-of-view information." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "SensorDataFilterOptions", + "type": "{http://www.onvif.org/ver10/schema}SensorDataFilterOptions", + "type_name": "SensorDataFilterOptions", + "definition": { + "kind": "complexType", + "name": "SensorDataFilterOptions", + "fields": [ + { + "name": "SensorIDFilterSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the device supports filtering sensor data by SensorID." + }, + { + "name": "TypeFilterSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "True if the device supports filtering sensor data by Type." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element indicating the sensor data filtering capabilities of the device." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationOptionsExtension", + "type_name": "MetadataConfigurationOptionsExtension", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationOptionsExtension", + "fields": [ + { + "name": "CompressionType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported metadata compression type. Its options shall be chosen from tt:MetadataCompressionType." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}MetadataConfigurationOptionsExtension2", + "type_name": "MetadataConfigurationOptionsExtension2", + "definition": { + "kind": "complexType", + "name": "MetadataConfigurationOptionsExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "GeoLocation", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "True if the device is able to stream the Geo Located positions of each target." + }, + { + "use": "optional", + "name": "MaxContentFilterSize", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "A device signalling support for content filtering shall support expressions with the provided expression size." + }, + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithms", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "If secure RTSP streaming is supported, this shall return the list of supported cryptographic algorithms as defined by tt:SrtpSecurityAlgorithms." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This message contains the metadata configuration options. If a metadata configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetAudioOutputConfigurationOptions", + "port_type": "Media2", + "description": "This operation returns the available options (supported values and ranges for audio output configuration parameters) for configuring an audio output. To retrieve the EQPresetList, a valid ConfigurationToken must be provided. If EQPreset is supported and isFrequencyDecibelEditable is signaled as true, the response shall include the FrequencyDecibelPair.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioOutputConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioOutputConfigurationOptions", + "schema": { + "name": "GetAudioOutputConfigurationOptions", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioOutputConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioOutputConfigurationOptionsResponse", + "schema": { + "name": "GetAudioOutputConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}AudioOutputConfigurationOptions", + "type_name": "AudioOutputConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioOutputConfigurationOptions", + "fields": [ + { + "name": "OutputTokensAvailable", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Tokens of the physical Audio outputs (typically one)." + }, + { + "name": "SendPrimacyOptions", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "An audio channel MAY support different types of audio transmission. While for full duplex\n\t\t\t\toperation no special handling is required, in half duplex operation the transmission direction\n\t\t\t\tneeds to be switched.\n\t\t\t\tThe optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which\n\t\t\t\tdirection is currently active. An NVC can switch between different modes by setting the\n\t\t\t\tAudioOutputConfiguration.
\n\t\t\t\tThe following modes for the Send-Primacy are defined:
    \n\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Server\n\t\t\t\t\t\tThe server is allowed to send audio data to the client. The client shall not send\n\t\t\t\t\t\taudio data via the backchannel to the NVT in this mode.
    • \n\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Client\n\t\t\t\t\t\tThe client is allowed to send audio data via the backchannel to the server. The\n\t\t\t\t\t\tNVT shall not send audio data to the client in this mode.
    • \n\t\t\t\t\t\t\t
  • www.onvif.org/ver20/HalfDuplex/Auto\n\t\t\t\t\t\tIt is up to the device how to deal with sending and receiving audio data.
    • \n\t\t\t\t\t\t
\n\t\t\t\tAcoustic echo cancellation is out of ONVIF scope." + }, + { + "name": "OutputLevelRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Minimum and maximum level range supported for this Output." + }, + { + "name": "EQPresetScheduleSupport", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether EQPreset scheduling is supported." + }, + { + "name": "EQPresets", + "type": "{http://www.onvif.org/ver10/schema}EQPreset", + "type_name": "EQPreset", + "definition": { + "kind": "complexType", + "name": "EQPreset", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique identifier for the preset." + }, + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Preset name. (Readonly)" + }, + { + "name": "isDefault", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This indicates whether the EQ preset is designated as the default. When the scheduler is inactive, this preset will be applied. Only one preset can be set as the default among the EQ presets linked to an audio output. If all presets have isDefault set to false, the device may automatically select one preset as the default." + }, + { + "name": "ScheduleToken", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional schedule token (if supported)." + }, + { + "name": "isFrequencyDecibelEditable", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the device allows changing the decibel level for frequencies. (Readonly)" + }, + { + "name": "FrequencyDecibelPair", + "type": "{http://www.onvif.org/ver10/schema}FrequencyDecibelPair", + "type_name": "FrequencyDecibelPair", + "definition": { + "kind": "complexType", + "name": "FrequencyDecibelPair", + "fields": [ + { + "name": "CenterFrequency", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The center frequency of the band in hertz (Readonly). For example, value of 1000 refers to 1kHz and 2000 refers to 2kHz." + }, + { + "name": "Decibel", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Decibel value associated with the center frequency." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of frequency decibel pairs, each defined by a center frequency and its corresponding decibel value." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported EQPresets." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This message contains the audio output configuration options. If a audio output configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetAudioDecoderConfigurationOptions", + "port_type": "Media2", + "description": "This command list the audio decoding capabilities for a given profile and configuration of a device.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioDecoderConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioDecoderConfigurationOptions", + "schema": { + "name": "GetAudioDecoderConfigurationOptions", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetConfiguration", + "type_name": "GetConfiguration", + "definition": { + "kind": "complexType", + "name": "GetConfiguration", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested configuration." + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioDecoderConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioDecoderConfigurationOptionsResponse", + "schema": { + "name": "GetAudioDecoderConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}AudioEncoder2ConfigurationOptions", + "type_name": "AudioEncoder2ConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "AudioEncoder2ConfigurationOptions", + "fields": [ + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and IANA Media Types." + }, + { + "name": "BitrateList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps for the specified Encoding." + }, + { + "name": "SampleRateList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported Sample Rates in kHz for the specified Encoding" + } + ], + "attributes": [ + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithms", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "If secure RTSP streaming is supported, this shall return the list of supported cryptographic algorithms as defined by tt:SrtpSecurityAlgorithms." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "This message contains the audio decoder configuration options. If a audio decoder configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetEQPresetConfiguration", + "port_type": "Media2", + "description": "This command is to configure Audio EQPreset.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetEQPresetConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetEQPresetConfiguration", + "schema": { + "name": "SetEQPresetConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}EQPreset", + "type_name": "EQPreset", + "definition": { + "kind": "complexType", + "name": "EQPreset", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique identifier for the preset." + }, + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Preset name. (Readonly)" + }, + { + "name": "isDefault", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This indicates whether the EQ preset is designated as the default. When the scheduler is inactive, this preset will be applied. Only one preset can be set as the default among the EQ presets linked to an audio output. If all presets have isDefault set to false, the device may automatically select one preset as the default." + }, + { + "name": "ScheduleToken", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional schedule token (if supported)." + }, + { + "name": "isFrequencyDecibelEditable", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the device allows changing the decibel level for frequencies. (Readonly)" + }, + { + "name": "FrequencyDecibelPair", + "type": "{http://www.onvif.org/ver10/schema}FrequencyDecibelPair", + "type_name": "FrequencyDecibelPair", + "definition": { + "kind": "complexType", + "name": "FrequencyDecibelPair", + "fields": [ + { + "name": "CenterFrequency", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The center frequency of the band in hertz (Readonly). For example, value of 1000 refers to 1kHz and 2000 refers to 2kHz." + }, + { + "name": "Decibel", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Decibel value associated with the center frequency." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of frequency decibel pairs, each defined by a center frequency and its corresponding decibel value." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified EQ Preset configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetEQPresetConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetEQPresetConfigurationResponse", + "schema": { + "name": "SetEQPresetConfigurationResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetVideoEncoderInstances", + "port_type": "Media2", + "description": "The GetVideoEncoderInstances command can be used to request the minimum number of guaranteed video encoder instances (applications) per Video Source Configuration.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetVideoEncoderInstancesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetVideoEncoderInstances", + "schema": { + "name": "GetVideoEncoderInstances", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the video source configuration" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetVideoEncoderInstancesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetVideoEncoderInstancesResponse", + "schema": { + "name": "GetVideoEncoderInstancesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Info", + "type": "{http://www.onvif.org/ver20/media/wsdl}EncoderInstanceInfo", + "type_name": "EncoderInstanceInfo", + "definition": { + "kind": "complexType", + "name": "EncoderInstanceInfo", + "fields": [ + { + "name": "Codec", + "type": "{http://www.onvif.org/ver20/media/wsdl}EncoderInstance", + "type_name": "EncoderInstance", + "definition": { + "kind": "complexType", + "name": "EncoderInstance", + "fields": [ + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and IANA Media Types." + }, + { + "name": "Number", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The minimum guaranteed number of encoder instances (applications) for the VideoSourceConfiguration." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "If a device limits the number of instances for respective Video Codecs the response contains the information how many streams can be set up at the same time per VideoSource." + }, + { + "name": "Total", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The minimum guaranteed total number of encoder instances (applications) per VideoSourceConfiguration. The device is able to deliver the Total number of streams" + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The minimum guaranteed total number of encoder instances (applications) per VideoSourceConfiguration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetStreamUri", + "port_type": "Media2", + "description": "This operation requests a URI that can be used to initiate a live media stream using RTSP as the control protocol. The returned URI shall remain valid indefinitely even if the profile is changed. Defined stream types are RtspUnicast RTSP streaming RTP as UDP Unicast. RtspMulticast RTSP streaming RTP as UDP Multicast. RtspsUnicast Secure RTSP streaming with SRTP as UDP Unicast. RtspsMulticast Secure RTSP streaming with SRTP as UDP Multicast. RTSP RTSP streaming RTP over TCP. RtspOverHttp Tunneling both the RTSP control channel and the RTP stream over HTTP or HTTPS. If a multicast stream is requested at least one of VideoEncoder2Configuration, AudioEncoder2Configuration and MetadataConfiguration shall have a valid multicast setting. For full compatibility with other ONVIF services a device should not generate Uris longer than 128 octets.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetStreamUriRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetStreamUri", + "schema": { + "name": "GetStreamUri", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Protocol", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the network protocol for streaming as defined by tr2:TransportProtocol" + }, + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetStreamUriResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetStreamUriResponse", + "schema": { + "name": "GetStreamUriResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Stable Uri to be used for requesting the media stream" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "StartMulticastStreaming", + "port_type": "Media2", + "description": "This command starts multicast streaming using a specified media profile of a device. Streaming continues until StopMulticastStreaming is called for the same Profile. The streaming shall continue after a reboot of the device until a StopMulticastStreaming request is received. The multicast address, port and TTL are configured in the VideoEncoderConfiguration, AudioEncoderConfiguration and MetadataConfiguration respectively.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}StartMulticastStreamingRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}StartMulticastStreaming", + "schema": { + "name": "StartMulticastStreaming", + "type": "{http://www.onvif.org/ver20/media/wsdl}StartStopMulticastStreaming", + "type_name": "StartStopMulticastStreaming", + "definition": { + "kind": "complexType", + "name": "StartStopMulticastStreaming", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of the Profile that is used to define the multicast stream." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}StartMulticastStreamingResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}StartMulticastStreamingResponse", + "schema": { + "name": "StartMulticastStreamingResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "StopMulticastStreaming", + "port_type": "Media2", + "description": "This command stops multicast streaming using a specified media profile of a device", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}StopMulticastStreamingRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}StopMulticastStreaming", + "schema": { + "name": "StopMulticastStreaming", + "type": "{http://www.onvif.org/ver20/media/wsdl}StartStopMulticastStreaming", + "type_name": "StartStopMulticastStreaming", + "definition": { + "kind": "complexType", + "name": "StartStopMulticastStreaming", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of the Profile that is used to define the multicast stream." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}StopMulticastStreamingResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}StopMulticastStreamingResponse", + "schema": { + "name": "StopMulticastStreamingResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetSynchronizationPoint", + "port_type": "Media2", + "description": "Synchronization points allow clients to decode and correctly use all data after the synchronization point. For example, if a video stream is configured with a large I-frame distance and a client loses a single packet, the client does not display video until the next I-frame is transmitted. In such cases, the client can request a Synchronization Point which enforces the device to add an I-Frame as soon as possible. Clients can request Synchronization Points for profiles. The device shall add synchronization points for all streams associated with this profile. Similarly, a synchronization point is used to get an update on full PTZ or event status through the metadata stream. If a video stream is associated with the profile, an I-frame shall be added to this video stream. If a PTZ metadata stream is associated to the profile, the PTZ position shall be repeated within the metadata stream.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetSynchronizationPointRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetSynchronizationPoint", + "schema": { + "name": "SetSynchronizationPoint", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a Profile reference for which a Synchronization Point is requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetSynchronizationPointResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetSynchronizationPointResponse", + "schema": { + "name": "SetSynchronizationPointResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetSnapshotUri", + "port_type": "Media2", + "description": "A client uses the GetSnapshotUri command to obtain a JPEG snapshot from the device. The returned URI shall remain valid indefinitely even if the profile is changed. The URI can be used for acquiring a JPEG image through an HTTP GET operation. The image encoding will always be JPEG regardless of the encoding setting in the media profile. The Jpeg settings (like resolution or quality) may be taken from the profile if suitable. The provided image will be updated automatically and independent from calls to GetSnapshotUri.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetSnapshotUriRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetSnapshotUri", + "schema": { + "name": "GetSnapshotUri", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The ProfileToken element indicates the media profile to use and will define the source and dimensions of the snapshot." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetSnapshotUriResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetSnapshotUriResponse", + "schema": { + "name": "GetSnapshotUriResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Uri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Stable Uri to be used for requesting snapshot images." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetVideoSourceModes", + "port_type": "Media2", + "description": "A device returns the information for current video source mode and settable video source modes of specified video source. A device that indicates a capability of VideoSourceModes shall support this command.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetVideoSourceModesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetVideoSourceModes", + "schema": { + "name": "GetVideoSourceModes", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a video source reference for which a video source mode is requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetVideoSourceModesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetVideoSourceModesResponse", + "schema": { + "name": "GetVideoSourceModesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceModes", + "type": "{http://www.onvif.org/ver20/media/wsdl}VideoSourceMode", + "type_name": "VideoSourceMode", + "definition": { + "kind": "complexType", + "name": "VideoSourceMode", + "fields": [ + { + "name": "MaxFramerate", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Max frame rate in frames per second for this video source mode." + }, + { + "name": "MaxResolution", + "type": "{http://www.onvif.org/ver10/schema}VideoResolution", + "type_name": "VideoResolution", + "definition": { + "kind": "complexType", + "name": "VideoResolution", + "fields": [ + { + "name": "Width", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image." + }, + { + "name": "Height", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Max horizontal and vertical resolution for this video source mode." + }, + { + "name": "Encodings", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of one or more encodings supported for this video source. For name definitions see tt:VideoEncodingMimeNames, and see IANA Media Types." + }, + { + "name": "Reboot", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "After setting the mode if a device starts to reboot this value is true. If a device change the mode without rebooting this value is false. If true, configured parameters may not be guaranteed by the device after rebooting." + }, + { + "name": "Description", + "type": "{http://www.onvif.org/ver10/schema}Description", + "type_name": "Description", + "definition": { + "kind": "simpleType", + "name": "Description", + "base": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Informative description of this video source mode. This field should be described in English." + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Indicate token for video source mode." + }, + { + "use": "optional", + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication of whether this mode is active. If active this value is true. In case of non-indication, it means as false. The value of true shall be had by only one video source mode." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Return the information for specified video source mode." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetVideoSourceMode", + "port_type": "Media2", + "description": "SetVideoSourceMode changes the media profile structure relating to video source for the specified video source mode. A device that indicates a capability of VideoSourceModes shall support this command. The behavior after changing the mode is not defined in this specification.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetVideoSourceModeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetVideoSourceMode", + "schema": { + "name": "SetVideoSourceMode", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "VideoSourceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains a video source reference for which a video source mode is requested." + }, + { + "name": "VideoSourceModeToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicate video source mode." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetVideoSourceModeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetVideoSourceModeResponse", + "schema": { + "name": "SetVideoSourceModeResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Reboot", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The response contains information about rebooting after returning response. When Reboot is set true, a device will reboot automatically after setting mode." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetOSDs", + "port_type": "Media2", + "description": "This operation lists existing OSD configurations for the device. If an OSD token is provided the device shall respond with the requested configuration or provide an error if it does not exist. In case only a video source configuration token is provided the device shall respond with all configurations that exist for the video source configuration. If no tokens are provided the device shall respond with all available OSD configurations.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetOSDsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetOSDs", + "schema": { + "name": "GetOSDs", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSDToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The GetOSDs command fetches the OSD configuration if the OSD token is known." + }, + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Token of the Video Source Configuration, which has OSDs associated with are requested. If token not exist, request all available OSDs." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetOSDsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetOSDsResponse", + "schema": { + "name": "GetOSDsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSDs", + "type": "{http://www.onvif.org/ver10/schema}OSDConfiguration", + "type_name": "OSDConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDConfiguration", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "VideoSourceConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}OSDReference", + "type_name": "OSDReference", + "definition": { + "kind": "complexType", + "name": "OSDReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the video source configuration." + }, + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}OSDType", + "type_name": "OSDType", + "definition": { + "kind": "simpleType", + "name": "OSDType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Text" + }, + { + "value": "Image" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of OSD." + }, + { + "name": "Position", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfiguration", + "type_name": "OSDPosConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDPosConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "For OSD position type, following are the pre-defined:
  • UpperLeft
    • \n\t\t\t\t\t\t
  • UpperRight
    • \n\t\t\t\t\t\t
  • LowerLeft
    • \n\t\t\t\t\t\t
  • LowerRight
    • \n\t\t\t\t\t\t
  • Custom
" + }, + { + "name": "Pos", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfigurationExtension", + "type_name": "OSDPosConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDPosConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Position configuration of OSD." + }, + { + "name": "TextString", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfiguration", + "type_name": "OSDTextConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDTextConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The following OSD Text Type are defined:
    \n\t\t\t\t\t\t\t
  • Plain - The Plain type means the OSD is shown as a text string which defined in the \"PlainText\" item.
    • \n\t\t\t\t\t\t\t
  • Date - The Date type means the OSD is shown as a date, format of which should be present in the \"DateFormat\" item.
    • \n\t\t\t\t\t\t\t
  • Time - The Time type means the OSD is shown as a time, format of which should be present in the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t\t
  • DateAndTime - The DateAndTime type means the OSD is shown as date and time, format of which should be present in the \"DateFormat\" and the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "DateFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD date formats. This element shall be present when the value of Type field has Date or DateAndTime. The following DateFormat are defined:
    \n\t\t\t\t\t\t\t
  • M/d/yyyy - e.g. 3/6/2013
    • \n\t\t\t\t\t\t\t
  • MM/dd/yyyy - e.g. 03/06/2013
    • \n\t\t\t\t\t\t\t
  • dd/MM/yyyy - e.g. 06/03/2013
    • \n\t\t\t\t\t\t\t
  • yyyy/MM/dd - e.g. 2013/03/06
    • \n\t\t\t\t\t\t\t
  • yyyy-MM-dd - e.g. 2013-06-03
    • \n\t\t\t\t\t\t\t
  • dddd, MMMM dd, yyyy - e.g. Wednesday, March 06, 2013
    • \n\t\t\t\t\t\t\t
  • MMMM dd, yyyy - e.g. March 06, 2013
    • \n\t\t\t\t\t\t\t
  • dd MMMM, yyyy - e.g. 06 March, 2013
    • \n\t\t\t\t\t\t
" + }, + { + "name": "TimeFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD time formats. This element shall be present when the value of Type field has Time or DateAndTime. The following TimeFormat are defined:
    \n\t\t\t\t\t\t\t
  • h:mm:ss tt - e.g. 2:14:21 PM
    • \n\t\t\t\t\t\t\t
  • hh:mm:ss tt - e.g. 02:14:21 PM
    • \n\t\t\t\t\t\t\t
  • H:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t\t
  • HH:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t
" + }, + { + "name": "FontSize", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font size of the text in pt." + }, + { + "name": "FontColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font color of the text." + }, + { + "name": "BackgroundColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Background color of the text." + }, + { + "name": "PlainText", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The content of text to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfigurationExtension", + "type_name": "OSDTextConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDTextConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "IsPersistentText", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "This flag is applicable for Type Plain and defaults to true. When set to false the PlainText content will not be persistent across device reboots." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Text configuration of OSD. It shall be present when the value of Type field is Text." + }, + { + "name": "Image", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfiguration", + "type_name": "OSDImgConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDImgConfiguration", + "fields": [ + { + "name": "ImgPath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The URI of the image which to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfigurationExtension", + "type_name": "OSDImgConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDImgConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Image configuration of OSD. It shall be present when the value of Type field is Image" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDConfigurationExtension", + "type_name": "OSDConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This element contains a list of requested OSDs." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetOSDOptions", + "port_type": "Media2", + "description": "Get the OSD Options.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetOSDOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetOSDOptions", + "schema": { + "name": "GetOSDOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Video Source Configuration Token that specifies an existing video source configuration that the options shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetOSDOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetOSDOptionsResponse", + "schema": { + "name": "GetOSDOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSDOptions", + "type": "{http://www.onvif.org/ver10/schema}OSDConfigurationOptions", + "type_name": "OSDConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "OSDConfigurationOptions", + "fields": [ + { + "name": "MaximumNumberOfOSDs", + "type": "{http://www.onvif.org/ver10/schema}MaximumNumberOfOSDs", + "type_name": "MaximumNumberOfOSDs", + "definition": { + "kind": "complexType", + "name": "MaximumNumberOfOSDs", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "Total", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "optional", + "name": "Image", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "optional", + "name": "PlainText", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "optional", + "name": "Date", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "optional", + "name": "Time", + "type": "{http://www.w3.org/2001/XMLSchema}int" + }, + { + "use": "optional", + "name": "DateAndTime", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The maximum number of OSD configurations supported for the specified video source configuration. If the configuration does not support OSDs, this value shall be zero and the Type and PositionOption elements are ignored. If a device limits the number of instances by OSDType, it shall indicate the supported number for each type via the related attribute." + }, + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}OSDType", + "type_name": "OSDType", + "definition": { + "kind": "simpleType", + "name": "OSDType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Text" + }, + { + "value": "Image" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List supported type of OSD configuration. When a device indicates the supported number for each types in MaximumNumberOfOSDs, related type shall be presented. A device shall return Option element relating to listed type." + }, + { + "name": "PositionOption", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List available OSD position type. Following are the pre-defined:
  • UpperLeft
    • \n\t\t\t\t\t\t
  • UpperRight
    • \n\t\t\t\t\t\t
  • LowerLeft
    • \n\t\t\t\t\t\t
  • LowerRight
    • \n\t\t\t\t\t\t
  • Custom
" + }, + { + "name": "TextOption", + "type": "{http://www.onvif.org/ver10/schema}OSDTextOptions", + "type_name": "OSDTextOptions", + "definition": { + "kind": "complexType", + "name": "OSDTextOptions", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported OSD text type. When a device indicates the supported number relating to Text type in MaximumNumberOfOSDs, the type shall be presented." + }, + { + "name": "FontSizeRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Range of the font size value." + }, + { + "name": "DateFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported date format." + }, + { + "name": "TimeFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of supported time format." + }, + { + "name": "FontColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColorOptions", + "type_name": "OSDColorOptions", + "definition": { + "kind": "complexType", + "name": "OSDColorOptions", + "description": "Describe the option of the color and its transparency.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorOptions", + "type_name": "ColorOptions", + "definition": { + "kind": "complexType", + "name": "ColorOptions", + "description": "Describe the colors supported. Either list each color or define the range of color values.", + "fields": [ + { + "name": "ColorList", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List the supported color." + }, + { + "name": "ColorspaceRange", + "type": "{http://www.onvif.org/ver10/schema}ColorspaceRange", + "type_name": "ColorspaceRange", + "definition": { + "kind": "complexType", + "name": "ColorspaceRange", + "fields": [ + { + "name": "X", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Y", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Z", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Define the range of color supported." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional list of supported colors." + }, + { + "name": "Transparent", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Range of the transparent level. Larger means more transparent." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDColorOptionsExtension", + "type_name": "OSDColorOptionsExtension", + "definition": { + "kind": "complexType", + "name": "OSDColorOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported font color." + }, + { + "name": "BackgroundColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColorOptions", + "type_name": "OSDColorOptions", + "definition": { + "kind": "complexType", + "name": "OSDColorOptions", + "description": "Describe the option of the color and its transparency.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorOptions", + "type_name": "ColorOptions", + "definition": { + "kind": "complexType", + "name": "ColorOptions", + "description": "Describe the colors supported. Either list each color or define the range of color values.", + "fields": [ + { + "name": "ColorList", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List the supported color." + }, + { + "name": "ColorspaceRange", + "type": "{http://www.onvif.org/ver10/schema}ColorspaceRange", + "type_name": "ColorspaceRange", + "definition": { + "kind": "complexType", + "name": "ColorspaceRange", + "fields": [ + { + "name": "X", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Y", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Z", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Define the range of color supported." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional list of supported colors." + }, + { + "name": "Transparent", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Range of the transparent level. Larger means more transparent." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDColorOptionsExtension", + "type_name": "OSDColorOptionsExtension", + "definition": { + "kind": "complexType", + "name": "OSDColorOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported background color." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDTextOptionsExtension", + "type_name": "OSDTextOptionsExtension", + "definition": { + "kind": "complexType", + "name": "OSDTextOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Option of the OSD text configuration. This element shall be returned if the device is signaling the support for Text." + }, + { + "name": "ImageOption", + "type": "{http://www.onvif.org/ver10/schema}OSDImgOptions", + "type_name": "OSDImgOptions", + "definition": { + "kind": "complexType", + "name": "OSDImgOptions", + "fields": [ + { + "name": "ImagePath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of available image URIs." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDImgOptionsExtension", + "type_name": "OSDImgOptionsExtension", + "definition": { + "kind": "complexType", + "name": "OSDImgOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "FormatsSupported", + "type": "{http://www.onvif.org/ver10/schema}StringAttrList", + "definition": { + "kind": "simpleType", + "name": "StringAttrList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "List of supported image MIME types, such as \"image/png\"." + }, + { + "use": "optional", + "name": "MaxSize", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The maximum size (in bytes) of the image that can be uploaded." + }, + { + "use": "optional", + "name": "MaxWidth", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The maximum width (in pixels) of the image that can be uploaded." + }, + { + "use": "optional", + "name": "MaxHeight", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The maximum height (in pixels) of the image that can be uploaded." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Option of the OSD image configuration. This element shall be returned if the device is signaling the support for Image." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDConfigurationOptionsExtension", + "type_name": "OSDConfigurationOptionsExtension", + "definition": { + "kind": "complexType", + "name": "OSDConfigurationOptionsExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetOSD", + "port_type": "Media2", + "description": "Set the OSD", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetOSDRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetOSD", + "schema": { + "name": "SetOSD", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSD", + "type": "{http://www.onvif.org/ver10/schema}OSDConfiguration", + "type_name": "OSDConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDConfiguration", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "VideoSourceConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}OSDReference", + "type_name": "OSDReference", + "definition": { + "kind": "complexType", + "name": "OSDReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the video source configuration." + }, + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}OSDType", + "type_name": "OSDType", + "definition": { + "kind": "simpleType", + "name": "OSDType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Text" + }, + { + "value": "Image" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of OSD." + }, + { + "name": "Position", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfiguration", + "type_name": "OSDPosConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDPosConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "For OSD position type, following are the pre-defined:
  • UpperLeft
    • \n\t\t\t\t\t\t
  • UpperRight
    • \n\t\t\t\t\t\t
  • LowerLeft
    • \n\t\t\t\t\t\t
  • LowerRight
    • \n\t\t\t\t\t\t
  • Custom
" + }, + { + "name": "Pos", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfigurationExtension", + "type_name": "OSDPosConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDPosConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Position configuration of OSD." + }, + { + "name": "TextString", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfiguration", + "type_name": "OSDTextConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDTextConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The following OSD Text Type are defined:
    \n\t\t\t\t\t\t\t
  • Plain - The Plain type means the OSD is shown as a text string which defined in the \"PlainText\" item.
    • \n\t\t\t\t\t\t\t
  • Date - The Date type means the OSD is shown as a date, format of which should be present in the \"DateFormat\" item.
    • \n\t\t\t\t\t\t\t
  • Time - The Time type means the OSD is shown as a time, format of which should be present in the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t\t
  • DateAndTime - The DateAndTime type means the OSD is shown as date and time, format of which should be present in the \"DateFormat\" and the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "DateFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD date formats. This element shall be present when the value of Type field has Date or DateAndTime. The following DateFormat are defined:
    \n\t\t\t\t\t\t\t
  • M/d/yyyy - e.g. 3/6/2013
    • \n\t\t\t\t\t\t\t
  • MM/dd/yyyy - e.g. 03/06/2013
    • \n\t\t\t\t\t\t\t
  • dd/MM/yyyy - e.g. 06/03/2013
    • \n\t\t\t\t\t\t\t
  • yyyy/MM/dd - e.g. 2013/03/06
    • \n\t\t\t\t\t\t\t
  • yyyy-MM-dd - e.g. 2013-06-03
    • \n\t\t\t\t\t\t\t
  • dddd, MMMM dd, yyyy - e.g. Wednesday, March 06, 2013
    • \n\t\t\t\t\t\t\t
  • MMMM dd, yyyy - e.g. March 06, 2013
    • \n\t\t\t\t\t\t\t
  • dd MMMM, yyyy - e.g. 06 March, 2013
    • \n\t\t\t\t\t\t
" + }, + { + "name": "TimeFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD time formats. This element shall be present when the value of Type field has Time or DateAndTime. The following TimeFormat are defined:
    \n\t\t\t\t\t\t\t
  • h:mm:ss tt - e.g. 2:14:21 PM
    • \n\t\t\t\t\t\t\t
  • hh:mm:ss tt - e.g. 02:14:21 PM
    • \n\t\t\t\t\t\t\t
  • H:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t\t
  • HH:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t
" + }, + { + "name": "FontSize", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font size of the text in pt." + }, + { + "name": "FontColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font color of the text." + }, + { + "name": "BackgroundColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Background color of the text." + }, + { + "name": "PlainText", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The content of text to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfigurationExtension", + "type_name": "OSDTextConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDTextConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "IsPersistentText", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "This flag is applicable for Type Plain and defaults to true. When set to false the PlainText content will not be persistent across device reboots." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Text configuration of OSD. It shall be present when the value of Type field is Text." + }, + { + "name": "Image", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfiguration", + "type_name": "OSDImgConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDImgConfiguration", + "fields": [ + { + "name": "ImgPath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The URI of the image which to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfigurationExtension", + "type_name": "OSDImgConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDImgConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Image configuration of OSD. It shall be present when the value of Type field is Image" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDConfigurationExtension", + "type_name": "OSDConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified OSD configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetOSDResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetOSDResponse", + "schema": { + "name": "SetOSDResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "CreateOSD", + "port_type": "Media2", + "description": "Create the OSD.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}CreateOSDRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}CreateOSD", + "schema": { + "name": "CreateOSD", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSD", + "type": "{http://www.onvif.org/ver10/schema}OSDConfiguration", + "type_name": "OSDConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDConfiguration", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "VideoSourceConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}OSDReference", + "type_name": "OSDReference", + "definition": { + "kind": "complexType", + "name": "OSDReference", + "base": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "base_definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "fields": [], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Reference to the video source configuration." + }, + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}OSDType", + "type_name": "OSDType", + "definition": { + "kind": "simpleType", + "name": "OSDType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Text" + }, + { + "value": "Image" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of OSD." + }, + { + "name": "Position", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfiguration", + "type_name": "OSDPosConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDPosConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "For OSD position type, following are the pre-defined:
  • UpperLeft
    • \n\t\t\t\t\t\t
  • UpperRight
    • \n\t\t\t\t\t\t
  • LowerLeft
    • \n\t\t\t\t\t\t
  • LowerRight
    • \n\t\t\t\t\t\t
  • Custom
" + }, + { + "name": "Pos", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDPosConfigurationExtension", + "type_name": "OSDPosConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDPosConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Position configuration of OSD." + }, + { + "name": "TextString", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfiguration", + "type_name": "OSDTextConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDTextConfiguration", + "fields": [ + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The following OSD Text Type are defined:
    \n\t\t\t\t\t\t\t
  • Plain - The Plain type means the OSD is shown as a text string which defined in the \"PlainText\" item.
    • \n\t\t\t\t\t\t\t
  • Date - The Date type means the OSD is shown as a date, format of which should be present in the \"DateFormat\" item.
    • \n\t\t\t\t\t\t\t
  • Time - The Time type means the OSD is shown as a time, format of which should be present in the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t\t
  • DateAndTime - The DateAndTime type means the OSD is shown as date and time, format of which should be present in the \"DateFormat\" and the \"TimeFormat\" item.
    • \n\t\t\t\t\t\t
" + }, + { + "name": "DateFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD date formats. This element shall be present when the value of Type field has Date or DateAndTime. The following DateFormat are defined:
    \n\t\t\t\t\t\t\t
  • M/d/yyyy - e.g. 3/6/2013
    • \n\t\t\t\t\t\t\t
  • MM/dd/yyyy - e.g. 03/06/2013
    • \n\t\t\t\t\t\t\t
  • dd/MM/yyyy - e.g. 06/03/2013
    • \n\t\t\t\t\t\t\t
  • yyyy/MM/dd - e.g. 2013/03/06
    • \n\t\t\t\t\t\t\t
  • yyyy-MM-dd - e.g. 2013-06-03
    • \n\t\t\t\t\t\t\t
  • dddd, MMMM dd, yyyy - e.g. Wednesday, March 06, 2013
    • \n\t\t\t\t\t\t\t
  • MMMM dd, yyyy - e.g. March 06, 2013
    • \n\t\t\t\t\t\t\t
  • dd MMMM, yyyy - e.g. 06 March, 2013
    • \n\t\t\t\t\t\t
" + }, + { + "name": "TimeFormat", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "List of supported OSD time formats. This element shall be present when the value of Type field has Time or DateAndTime. The following TimeFormat are defined:
    \n\t\t\t\t\t\t\t
  • h:mm:ss tt - e.g. 2:14:21 PM
    • \n\t\t\t\t\t\t\t
  • hh:mm:ss tt - e.g. 02:14:21 PM
    • \n\t\t\t\t\t\t\t
  • H:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t\t
  • HH:mm:ss - e.g. 14:14:21
    • \n\t\t\t\t\t\t
" + }, + { + "name": "FontSize", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font size of the text in pt." + }, + { + "name": "FontColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Font color of the text." + }, + { + "name": "BackgroundColor", + "type": "{http://www.onvif.org/ver10/schema}OSDColor", + "type_name": "OSDColor", + "definition": { + "kind": "complexType", + "name": "OSDColor", + "description": "The value range of \"Transparent\" could be defined by vendors only and should follow this rule: the minimum value means non-transparent and the maximum value means fully transparent.", + "fields": [ + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "Transparent", + "type": "{http://www.w3.org/2001/XMLSchema}int" + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Background color of the text." + }, + { + "name": "PlainText", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The content of text to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDTextConfigurationExtension", + "type_name": "OSDTextConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDTextConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "IsPersistentText", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "This flag is applicable for Type Plain and defaults to true. When set to false the PlainText content will not be persistent across device reboots." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Text configuration of OSD. It shall be present when the value of Type field is Text." + }, + { + "name": "Image", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfiguration", + "type_name": "OSDImgConfiguration", + "definition": { + "kind": "complexType", + "name": "OSDImgConfiguration", + "fields": [ + { + "name": "ImgPath", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The URI of the image which to be displayed." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDImgConfigurationExtension", + "type_name": "OSDImgConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDImgConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Image configuration of OSD. It shall be present when the value of Type field is Image" + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}OSDConfigurationExtension", + "type_name": "OSDConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "OSDConfigurationExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contain the initial OSD configuration for create." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}CreateOSDResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}CreateOSDResponse", + "schema": { + "name": "CreateOSDResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSDToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Returns Token of the newly created OSD" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "DeleteOSD", + "port_type": "Media2", + "description": "Delete the OSD.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}DeleteOSDRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}DeleteOSD", + "schema": { + "name": "DeleteOSD", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "OSDToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This element contains a reference to the OSD configuration that should be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}DeleteOSDResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}DeleteOSDResponse", + "schema": { + "name": "DeleteOSDResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetMasks", + "port_type": "Media2", + "description": "This operation lists existing Mask configurations for the device. If an Mask token is provided the device shall respond with the requested configuration or provide an error if it does not exist. In case only a video source configuration token is provided the device shall respond with all configurations that exist for the video source configuration. If no tokens are provided the device shall respond with all available Mask configurations.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetMasksRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetMasks", + "schema": { + "name": "GetMasks", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional mask token of an existing mask." + }, + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional token of a Video Source Configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetMasksResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetMasksResponse", + "schema": { + "name": "GetMasksResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Masks", + "type": "{http://www.onvif.org/ver20/media/wsdl}Mask", + "type_name": "Mask", + "definition": { + "kind": "complexType", + "name": "Mask", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the VideoSourceConfiguration the Mask is associated with." + }, + { + "name": "Polygon", + "type": "{http://www.onvif.org/ver10/schema}Polygon", + "type_name": "Polygon", + "definition": { + "kind": "complexType", + "name": "Polygon", + "fields": [ + { + "name": "Point", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 3, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Geometric representation of the mask area." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of masking as defined by tr2:MaskType:\n\t\t\t\t\t\t\t
    \n\t\t\t\t\t\t\t\t
  • Color - The masked area is colored with color defined by the Color field.
    • \n\t\t\t\t\t\t\t\t
  • Pixelated - The masked area is filled in mosaic style to hide details.
    • \n\t\t\t\t\t\t\t\t
  • Blurred - The masked area is low pass filtered to hide details.
    • \n\t\t\t\t\t\t\t
" + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Color of the masked area." + }, + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If set the mask will cover the image, otherwise it will be fully transparent." + } + ], + "attributes": [ + { + "use": "optional", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token of the mask." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of Mask configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetMaskOptions", + "port_type": "Media2", + "description": "Get the Mask Options.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetMaskOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetMaskOptions", + "schema": { + "name": "GetMaskOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Video Source Configuration Token that specifies an existing video source configuration that the options shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetMaskOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetMaskOptionsResponse", + "schema": { + "name": "GetMaskOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver20/media/wsdl}MaskOptions", + "type_name": "MaskOptions", + "definition": { + "kind": "complexType", + "name": "MaskOptions", + "fields": [ + { + "name": "MaxMasks", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum supported number of masks per VideoSourceConfiguration." + }, + { + "name": "MaxPoints", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Maximum supported number of points per mask." + }, + { + "name": "Types", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Information which types of tr2:MaskType are supported. Valid values are 'Color', 'Pixelated' and 'Blurred'." + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}ColorOptions", + "type_name": "ColorOptions", + "definition": { + "kind": "complexType", + "name": "ColorOptions", + "description": "Describe the colors supported. Either list each color or define the range of color values.", + "fields": [ + { + "name": "ColorList", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "List the supported color." + }, + { + "name": "ColorspaceRange", + "type": "{http://www.onvif.org/ver10/schema}ColorspaceRange", + "type_name": "ColorspaceRange", + "definition": { + "kind": "complexType", + "name": "ColorspaceRange", + "fields": [ + { + "name": "X", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Y", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Z", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Acceptable values are the same as in tt:Color." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Define the range of color supported." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Colors supported." + } + ], + "attributes": [ + { + "use": "optional", + "name": "RectangleOnly", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Information whether the polygon must have four points and a rectangular shape." + }, + { + "use": "optional", + "name": "SingleColorOnly", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates the device capability of change in color of privacy mask for one video source configuration will automatically be applied to all the privacy masks associated with the same video source configuration." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetMask", + "port_type": "Media2", + "description": "Set the Mask", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetMaskRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetMask", + "schema": { + "name": "SetMask", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Mask", + "type": "{http://www.onvif.org/ver20/media/wsdl}Mask", + "type_name": "Mask", + "definition": { + "kind": "complexType", + "name": "Mask", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the VideoSourceConfiguration the Mask is associated with." + }, + { + "name": "Polygon", + "type": "{http://www.onvif.org/ver10/schema}Polygon", + "type_name": "Polygon", + "definition": { + "kind": "complexType", + "name": "Polygon", + "fields": [ + { + "name": "Point", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 3, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Geometric representation of the mask area." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of masking as defined by tr2:MaskType:\n\t\t\t\t\t\t\t
    \n\t\t\t\t\t\t\t\t
  • Color - The masked area is colored with color defined by the Color field.
    • \n\t\t\t\t\t\t\t\t
  • Pixelated - The masked area is filled in mosaic style to hide details.
    • \n\t\t\t\t\t\t\t\t
  • Blurred - The masked area is low pass filtered to hide details.
    • \n\t\t\t\t\t\t\t
" + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Color of the masked area." + }, + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If set the mask will cover the image, otherwise it will be fully transparent." + } + ], + "attributes": [ + { + "use": "optional", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token of the mask." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Mask to be updated." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetMaskResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetMaskResponse", + "schema": { + "name": "SetMaskResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "CreateMask", + "port_type": "Media2", + "description": "Create the Mask.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}CreateMaskRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}CreateMask", + "schema": { + "name": "CreateMask", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Mask", + "type": "{http://www.onvif.org/ver20/media/wsdl}Mask", + "type_name": "Mask", + "definition": { + "kind": "complexType", + "name": "Mask", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the VideoSourceConfiguration the Mask is associated with." + }, + { + "name": "Polygon", + "type": "{http://www.onvif.org/ver10/schema}Polygon", + "type_name": "Polygon", + "definition": { + "kind": "complexType", + "name": "Polygon", + "fields": [ + { + "name": "Point", + "type": "{http://www.onvif.org/ver10/schema}Vector", + "type_name": "Vector", + "definition": { + "kind": "complexType", + "name": "Vector", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + } + ] + }, + "min_occurs": 3, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Geometric representation of the mask area." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Type of masking as defined by tr2:MaskType:\n\t\t\t\t\t\t\t
    \n\t\t\t\t\t\t\t\t
  • Color - The masked area is colored with color defined by the Color field.
    • \n\t\t\t\t\t\t\t\t
  • Pixelated - The masked area is filled in mosaic style to hide details.
    • \n\t\t\t\t\t\t\t\t
  • Blurred - The masked area is low pass filtered to hide details.
    • \n\t\t\t\t\t\t\t
" + }, + { + "name": "Color", + "type": "{http://www.onvif.org/ver10/schema}Color", + "type_name": "Color", + "definition": { + "kind": "complexType", + "name": "Color", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "X", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "Z", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "Colorspace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Acceptable values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr\n\t\t\t\t\t\t\t
    • X attribute = Y value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = Cb value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = Cr value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/RGB - RGB\n\t\t\t\t\t\t\t
    • X attribute = R value
      • \n\t\t\t\t\t\t\t\t
    • Y attribute = G value
      • \n\t\t\t\t\t\t\t\t
    • Z attribute = B value
    \n\t\t\t\t\t\t
    • \n\t\t\t\t\t
\n\t\t\t\t\tIf the Colorspace attribute is absent and not defined on higher level, YCbCr is implied.\n\n\t\t\t\t\tDeprecated values:\n\t\t\t\t\t
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/colorspace/HSV - HSV
    • \n\t\t\t\t\t
" + }, + { + "use": "optional", + "name": "Likelihood", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Likelihood that the color is correct." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Color of the masked area." + }, + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If set the mask will cover the image, otherwise it will be fully transparent." + } + ], + "attributes": [ + { + "use": "optional", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token of the mask." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contain the initial mask configuration for create." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}CreateMaskResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}CreateMaskResponse", + "schema": { + "name": "CreateMaskResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Returns Token of the newly created Mask" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "DeleteMask", + "port_type": "Media2", + "description": "Delete the Mask.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}DeleteMaskRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}DeleteMask", + "schema": { + "name": "DeleteMask", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "This element contains a reference to the Mask configuration that should be deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}DeleteMaskResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}DeleteMaskResponse", + "schema": { + "name": "DeleteMaskResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetWebRTCConfigurations", + "port_type": "Media2", + "description": "This operation gets the current WebRTC configuration for the device.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetWebRTCConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetWebRTCConfigurations", + "schema": { + "name": "GetWebRTCConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetWebRTCConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetWebRTCConfigurationsResponse", + "schema": { + "name": "GetWebRTCConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "WebRTCConfiguration", + "type": "{http://www.onvif.org/ver20/media/wsdl}WebRTCConfiguration", + "type_name": "WebRTCConfiguration", + "definition": { + "kind": "complexType", + "name": "WebRTCConfiguration", + "fields": [ + { + "name": "SignalingServer", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The signaling server URI." + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The CertPathValidationPolicyID for validating the signaling server certificate." + }, + { + "name": "AuthorizationServer", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The Authorization Server to use for getting access tokens. This refers to an entity in the list of configured Authorization Servers in the [ONVIF Security Service Specification]." + }, + { + "name": "DefaultProfile", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The default media profile to use for streaming if no specific profile is specified when initializing a session." + }, + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Enables/disables the configuration." + }, + { + "name": "Connected", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the device is connected to the server. This parameter is read-only." + }, + { + "name": "Error", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable error information (readonly)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Video Source Configuration Token that specifies an existing video source configuration that the options shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetWebRTCConfigurations", + "port_type": "Media2", + "description": "This operation sets the WebRTC configuration for the device.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetWebRTCConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetWebRTCConfigurations", + "schema": { + "name": "SetWebRTCConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "WebRTCConfiguration", + "type": "{http://www.onvif.org/ver20/media/wsdl}WebRTCConfiguration", + "type_name": "WebRTCConfiguration", + "definition": { + "kind": "complexType", + "name": "WebRTCConfiguration", + "fields": [ + { + "name": "SignalingServer", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The signaling server URI." + }, + { + "name": "CertPathValidationPolicyID", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The CertPathValidationPolicyID for validating the signaling server certificate." + }, + { + "name": "AuthorizationServer", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The Authorization Server to use for getting access tokens. This refers to an entity in the list of configured Authorization Servers in the [ONVIF Security Service Specification]." + }, + { + "name": "DefaultProfile", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The default media profile to use for streaming if no specific profile is specified when initializing a session." + }, + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Enables/disables the configuration." + }, + { + "name": "Connected", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the device is connected to the server. This parameter is read-only." + }, + { + "name": "Error", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional user readable error information (readonly)." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This message contains the WebRTC configurations to use for the device. If empty, existing WebRTC configurations are deleted." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetWebRTCConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetWebRTCConfigurationsResponse", + "schema": { + "name": "SetWebRTCConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetAudioClips", + "port_type": "Media2", + "description": "This operation retrieves audio clip configurations from the device. If an audio clip token is provided, the device shall return the audio clip configuration associated with that token. If no token is provided, the device shall return all audio clip configurations that exist on the device.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioClipsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioClips", + "schema": { + "name": "GetAudioClips", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Audio clip token." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetAudioClipsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetAudioClipsResponse", + "schema": { + "name": "GetAudioClipsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AudioClipItem", + "type": "{http://www.onvif.org/ver20/media/wsdl}GetAudioClipsResponseItem", + "type_name": "GetAudioClipsResponseItem", + "definition": { + "kind": "complexType", + "name": "GetAudioClipsResponseItem", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique token associated with the audio clip." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver20/media/wsdl}AudioClip", + "type_name": "AudioClip", + "definition": { + "kind": "complexType", + "name": "AudioClip", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Enables/disables the audio clip." + }, + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Name of the audio clip." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional token list of physical audio outputs." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Format of the audio clip. For definitions see tr2:SupportedAudioClipFormat parameter." + }, + { + "name": "RepeatCycles", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The number of times the audio clip can be repeated when it is played. A value of 0 means no repeat (i.e., the audio clip plays once and does not repeat). A value of 1 means the audio clip plays once and repeats once after the first play. A value of -1 means the audio clip repeats infinitely after the first play until it is stopped by the user." + }, + { + "name": "RepeatInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional time interval, in seconds, between audio clips when the audio clip is repeated." + }, + { + "name": "AudioOutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level to control the volume of the audio clip when it is played." + }, + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional schedule token associated with the audio clip configuration. The audio clip shall be played when the configured schedule is triggered." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Configuration of the audio clip." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of audio clip items." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "AddAudioClip", + "port_type": "Media2", + "description": "This operation adds audio clip configuration to the device and provides audio clip upload URI to the client. The response to the command includes an HTTP URL to which the audio clip may be uploaded within the expiry time. If the client is unable to upload the audio clip within the URL's expiry time, the associated audio clip configuration will be permanently removed from the device.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}AddAudioClipRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}AddAudioClip", + "schema": { + "name": "AddAudioClip", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional token associated with the audio clip." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver20/media/wsdl}AudioClip", + "type_name": "AudioClip", + "definition": { + "kind": "complexType", + "name": "AudioClip", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Enables/disables the audio clip." + }, + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Name of the audio clip." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional token list of physical audio outputs." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Format of the audio clip. For definitions see tr2:SupportedAudioClipFormat parameter." + }, + { + "name": "RepeatCycles", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The number of times the audio clip can be repeated when it is played. A value of 0 means no repeat (i.e., the audio clip plays once and does not repeat). A value of 1 means the audio clip plays once and repeats once after the first play. A value of -1 means the audio clip repeats infinitely after the first play until it is stopped by the user." + }, + { + "name": "RepeatInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional time interval, in seconds, between audio clips when the audio clip is repeated." + }, + { + "name": "AudioOutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level to control the volume of the audio clip when it is played." + }, + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional schedule token associated with the audio clip configuration. The audio clip shall be played when the configured schedule is triggered." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio clip configuration to add." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}AddAudioClipResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}AddAudioClipResponse", + "schema": { + "name": "AddAudioClipResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique token of the audio clip to be uploaded." + }, + { + "name": "UploadUri", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URL to which the audio clip can be uploaded." + }, + { + "name": "ExpiryTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Expiry time by which the client should upload the audio clip to the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "AddTTSAudioClip", + "port_type": "Media2", + "description": "This operation sends a text and its configuartion to device that supports TTS function, so that device could convert the text into an audio clip and play it according to audio clip Configuration and TTS Configuration.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}AddTTSAudioClipRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}AddTTSAudioClip", + "schema": { + "name": "AddTTSAudioClip", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional token associated with the audio clip." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver20/media/wsdl}AudioClip", + "type_name": "AudioClip", + "definition": { + "kind": "complexType", + "name": "AudioClip", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Enables/disables the audio clip." + }, + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Name of the audio clip." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional token list of physical audio outputs." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Format of the audio clip. For definitions see tr2:SupportedAudioClipFormat parameter." + }, + { + "name": "RepeatCycles", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The number of times the audio clip can be repeated when it is played. A value of 0 means no repeat (i.e., the audio clip plays once and does not repeat). A value of 1 means the audio clip plays once and repeats once after the first play. A value of -1 means the audio clip repeats infinitely after the first play until it is stopped by the user." + }, + { + "name": "RepeatInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional time interval, in seconds, between audio clips when the audio clip is repeated." + }, + { + "name": "AudioOutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level to control the volume of the audio clip when it is played." + }, + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional schedule token associated with the audio clip configuration. The audio clip shall be played when the configured schedule is triggered." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio clip configuration to add." + }, + { + "name": "TTSConfiguration", + "type": "{http://www.onvif.org/ver20/media/wsdl}TTSAudio", + "type_name": "TTSAudio", + "definition": { + "kind": "complexType", + "name": "TTSAudio", + "fields": [ + { + "name": "Content", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Content of the audio clip." + }, + { + "name": "Language", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The language that is supported by the device and used for TTS audio clip playback. \n Uses ISO 639-1 alpha-2 language codes for definition, such as\"en\" for English. See Codes for the Representation of Names of Languages.\n Optionally combined with ISO 3166-1 alpha-2 country codes using the \"language-country\" format to specify regional variations, such as\"en-US\" for American English. For country codes, see ISO 3166-1 Country Codes." + }, + { + "name": "VoiceType", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The voice type that is supported by the device and used for TTS audio clip playback. See tr2: TTSVoiceType." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The configuration for the TTS audio clip to add." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}AddTTSAudioClipResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}AddTTSAudioClipResponse", + "schema": { + "name": "AddTTSAudioClipResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique token assigned by device for the TTS audio clip." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetAudioClip", + "port_type": "Media2", + "description": "This operation modifies the existing audio clip configuration on the device.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetAudioClipRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetAudioClip", + "schema": { + "name": "SetAudioClip", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique token associated with the audio clip." + }, + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver20/media/wsdl}AudioClip", + "type_name": "AudioClip", + "definition": { + "kind": "complexType", + "name": "AudioClip", + "fields": [ + { + "name": "Enabled", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Enables/disables the audio clip." + }, + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Name of the audio clip." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional token list of physical audio outputs." + }, + { + "name": "Type", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Format of the audio clip. For definitions see tr2:SupportedAudioClipFormat parameter." + }, + { + "name": "RepeatCycles", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The number of times the audio clip can be repeated when it is played. A value of 0 means no repeat (i.e., the audio clip plays once and does not repeat). A value of 1 means the audio clip plays once and repeats once after the first play. A value of -1 means the audio clip repeats infinitely after the first play until it is stopped by the user." + }, + { + "name": "RepeatInterval", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional time interval, in seconds, between audio clips when the audio clip is repeated." + }, + { + "name": "AudioOutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional level to control the volume of the audio clip when it is played." + }, + { + "name": "ScheduleToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional schedule token associated with the audio clip configuration. The audio clip shall be played when the configured schedule is triggered." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio clip configuration to modify." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetAudioClipResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetAudioClipResponse", + "schema": { + "name": "SetAudioClipResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "DeleteAudioClip", + "port_type": "Media2", + "description": "This operation deletes the audio clip configuration and the associated audio clip on the device. The audio clip should be de-associated from the event or schedule trigger if it was previously associated before this operation. This operation will fail if the device is playing the audio clip at the same time due to user operation, schedule, or event trigger.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}DeleteAudioClipRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}DeleteAudioClip", + "schema": { + "name": "DeleteAudioClip", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the audio clip to be deleted from the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}DeleteAudioClipResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}DeleteAudioClipResponse", + "schema": { + "name": "DeleteAudioClipResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "PlayAudioClip", + "port_type": "Media2", + "description": "This operation plays or stops the ongoing audio clip on the device.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}PlayAudioClipRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}PlayAudioClip", + "schema": { + "name": "PlayAudioClip", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the audio clip to be played or stopped." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Optional token list of physical audio outputs. If the AudioOutputToken is not provided in the API request, the AudioOutputToken from the audio clip configuration will be used." + }, + { + "name": "Play", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "If it is true, play the audio clip; if it is false, stop the ongoing audio clip." + }, + { + "name": "RepeatCycles", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional RepeatCycles to be used for the current play operation. If RepeatCycles is not provided in the API request, the RepeatCycles specified in the audio clip configuration will be used for the current play operation." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}PlayAudioClipResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}PlayAudioClipResponse", + "schema": { + "name": "PlayAudioClipResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetPlayingAudioClips", + "port_type": "Media2", + "description": "This operation retrieves audio clips information which are playing currently in the device.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetPlayingAudioClipsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetPlayingAudioClips", + "schema": { + "name": "GetPlayingAudioClips", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetPlayingAudioClipsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetPlayingAudioClipsResponse", + "schema": { + "name": "GetPlayingAudioClipsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PlayingAudioClips", + "type": "{http://www.onvif.org/ver20/media/wsdl}PlayingAudioClips", + "type_name": "PlayingAudioClips", + "definition": { + "kind": "complexType", + "name": "PlayingAudioClips", + "fields": [ + { + "name": "Token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Unique token associated with the audio clip." + }, + { + "name": "Name", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Name of the audio clip." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false, + "description": "Token list of physical audio outputs." + }, + { + "name": "AudioOutputLevel", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Output level to control the volume of the audio clip when it is played." + }, + { + "name": "RepeatsLeft", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of repeat cycles left while playing the audio clip." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "List of audio clips currently playing in the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetMulticastAudioDecoderConfigurations", + "port_type": "Media2", + "description": "This operation gets the list of multicast audio decoder configurations.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetMulticastAudioDecoderConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetMulticastAudioDecoderConfigurations", + "schema": { + "name": "GetMulticastAudioDecoderConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Unique token of the multicast audio decoder configuration. If not passed, device shall respond with all configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetMulticastAudioDecoderConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetMulticastAudioDecoderConfigurationsResponse", + "schema": { + "name": "GetMulticastAudioDecoderConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configurations", + "type": "{http://www.onvif.org/ver10/schema}MulticastAudioDecoderConfiguration", + "type_name": "MulticastAudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastAudioDecoderConfiguration", + "description": "Configuration for the Multicast Audio Decoder.", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Enable", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the Multicast Audio Decoder is enabled or disabled." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Token of the physical Audio output. This element is optional and can occur multiple times." + }, + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the encoding type according to IANA media types." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The bitrate of the audio stream in bits per second." + }, + { + "name": "SamplingRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The sampling rate of the audio stream in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastReceiverConfiguration", + "type_name": "MulticastReceiverConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastReceiverConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast port used for receiving. The RTP port number shall be even. If RTCP is supported, the corresponding RTCP stream shall be mapped to the next higher (odd) port number as defined in RFC 3550." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "InterfaceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Unique identifier of the network interface on the device. If not specified, all available interfaces will be used for listening." + }, + { + "name": "SourceSpecificMulticast", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "When a source-specific multicast address is configured, the device will process multicast data only from the specified source, in accordance with SSM principles defined in RFC 4607." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains configuration details for multicast settings." + }, + { + "name": "RTPPayloadType", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the RTP payload type used for the audio stream.\n\t\t\t\t\t\t\tTo ensure compatibility, it is recommended to use dynamic payload types (96 and above), as specified in RFC 3551.\n\t\t\t\t\t\t\tStandard payload types (0-95) should only be used for predefined audio formats matching the audio encoding as defined in\n\t\t\t\t\t\t\tIANA RTP Payload Types,\n\t\t\t\t\t\t\tas using them for non-standard media may lead to unexpected errors or interoperability issues." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the priority level when multiple configurations are active.\n\t\t\t\t\t\t\t\tA higher value signifies a higher priority. If several configurations have the same priority value the order between those configurations is undefined." + }, + { + "name": "MediaFormatParameters", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional media format parameters as specified in SDP, such as:\n\t\t\t\t\t\t\t\ta=fmtp:101 stereo=1; sprop-stereo=1." + }, + { + "name": "SRTPPreSharedParameters", + "type": "{http://www.onvif.org/ver10/schema}SRTPPreShared", + "type_name": "SRTPPreShared", + "definition": { + "kind": "complexType", + "name": "SRTPPreShared", + "fields": [ + { + "name": "SRTPPSK", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "SRTP Pre-Shared Key (PSK) represented as a hexadecimal string.\n\t\t\t\tThis includes both the SRTP master key, followed by the master salt.\n\t\t\t\tThe sizes of the key and salt depend on the specified SecureStreamingProtocolAlgorithm.\n\t\t\t\tThe SRTPPSK shall be returned as an empty string on a get method.\n\t\t\t\tIn SetMulticastAudioDecoderConfiguration requests, if SRTPPreSharedParameters is present but \n\t\t\t\tSRTPPSK is empty, the device shall retain the previously configured pre-shared key.\n\t\t\t\tTo update the PSK, a valid non-empty hexadecimal value must be provided." + }, + { + "name": "ROCExtMapID", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP header extension ID (ExtMapID) used to identify the ROC extension, as defined in RFC 8285.\n\t\t\t\tValid values are 1 to 14 for one-byte header extensions." + } + ], + "attributes": [ + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Specifies the cryptographic algorithm when using SRTP,\n\t\t\t\tselecting from predefined values provided in the GetMulticastAudioDecoderConfigurationOptions response." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration parameters for SRTP pre-shared key usage, applicable when SRTP is supported. When this configuration is present, RTP packets shall be encrypted.\n\t\t\t\t\t\t\t\t When this configuration is absent, RTP packets shall not be encrypted. \n\t\t\t\t\t\t\t\tOn GetMulticastAudioDecoderConfiguration, this element shall be present only if encryption is enabled; it shall be absent if encryption is disabled." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "This message contains the list of multicast audio decoder configurations." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "GetMulticastAudioDecoderConfigurationOptions", + "port_type": "Media2", + "description": "This operation gets the available options for the MulticastAudioDecoder configuration.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetMulticastAudioDecoderConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetMulticastAudioDecoderConfigurationOptions", + "schema": { + "name": "GetMulticastAudioDecoderConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "This response contains the available MulticastAudioDecoderConfigurationOptions. If a multicast audio decoder configuration is specified, the options shall concern that particular configuration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}GetMulticastAudioDecoderConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}GetMulticastAudioDecoderConfigurationOptionsResponse", + "schema": { + "name": "GetMulticastAudioDecoderConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}MulticastAudioDecoderConfigurationOptions", + "type_name": "MulticastAudioDecoderConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "MulticastAudioDecoderConfigurationOptions", + "fields": [ + { + "name": "EncodingOptions", + "type": "{http://www.onvif.org/ver10/schema}AudioDecoder2Options", + "type_name": "AudioDecoder2Options", + "definition": { + "kind": "complexType", + "name": "AudioDecoder2Options", + "fields": [ + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and IANA Media Types." + }, + { + "name": "BitrateList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported bitrates in kbps for the specified Encoding." + }, + { + "name": "SampleRateList", + "type": "{http://www.onvif.org/ver10/schema}IntItems", + "type_name": "IntItems", + "definition": { + "kind": "complexType", + "name": "IntItems", + "description": "List of values.", + "fields": [ + { + "name": "Items", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "List of supported Sample Rates in kHz for the specified Encoding" + }, + { + "name": "RTPPayloadType", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element for specifying the RTP payload type,\n\t\t\t\t\t\tparticularly when it is fixed for a specific audio encoding as defined in IANA RTP Payload Types." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported encoding options for the multicast audio decoder." + }, + { + "name": "PriorityRange", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the priority range as an integer. This indicates the priority level for audio configuration." + }, + { + "name": "AudioOutputTokens", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "type_name": "StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional list of physical Audio output tokens. This element is used when only certain audio outputs can be configured for this token." + } + ], + "attributes": [ + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithms", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "An optional parameter specifies the list of supported cryptographic algorithms when SRTP support is signaled as 'true' in the GetServiceCapabilitiesResponse.\n\t\t\t\tRefer to tt:SrtpSecurityAlgorithms for the acceptable values." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + }, + { + "name": "SetMulticastAudioDecoderConfiguration", + "port_type": "Media2", + "description": "This operation sets the MulticastAudioDecoderConfiguration.", + "input": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetMulticastAudioDecoderConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetMulticastAudioDecoderConfiguration", + "schema": { + "name": "SetMulticastAudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Configuration", + "type": "{http://www.onvif.org/ver10/schema}MulticastAudioDecoderConfiguration", + "type_name": "MulticastAudioDecoderConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastAudioDecoderConfiguration", + "description": "Configuration for the Multicast Audio Decoder.", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "Enable", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether the Multicast Audio Decoder is enabled or disabled." + }, + { + "name": "AudioOutputToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Token of the physical Audio output. This element is optional and can occur multiple times." + }, + { + "name": "Encoding", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the encoding type according to IANA media types." + }, + { + "name": "Bitrate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The bitrate of the audio stream in bits per second." + }, + { + "name": "SamplingRate", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The sampling rate of the audio stream in kHz." + }, + { + "name": "Multicast", + "type": "{http://www.onvif.org/ver10/schema}MulticastReceiverConfiguration", + "type_name": "MulticastReceiverConfiguration", + "definition": { + "kind": "complexType", + "name": "MulticastReceiverConfiguration", + "fields": [ + { + "name": "Address", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The multicast address (if this address is set to 0 no multicast streaming is enabled)" + }, + { + "name": "Port", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP multicast port used for receiving. The RTP port number shall be even. If RTCP is supported, the corresponding RTCP stream shall be mapped to the next higher (odd) port number as defined in RFC 3550." + }, + { + "name": "TTL", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope." + }, + { + "name": "InterfaceToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Unique identifier of the network interface on the device. If not specified, all available interfaces will be used for listening." + }, + { + "name": "SourceSpecificMulticast", + "type": "{http://www.onvif.org/ver10/schema}IPAddress", + "type_name": "IPAddress", + "definition": { + "kind": "complexType", + "name": "IPAddress", + "fields": [ + { + "name": "Type", + "type": "{http://www.onvif.org/ver10/schema}IPType", + "type_name": "IPType", + "definition": { + "kind": "simpleType", + "name": "IPType", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the address is an IPv4 or IPv6 address." + }, + { + "name": "IPv4Address", + "type": "{http://www.onvif.org/ver10/schema}IPv4Address", + "type_name": "IPv4Address", + "definition": { + "kind": "simpleType", + "name": "IPv4Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv4 address." + }, + { + "name": "IPv6Address", + "type": "{http://www.onvif.org/ver10/schema}IPv6Address", + "type_name": "IPv6Address", + "definition": { + "kind": "simpleType", + "name": "IPv6Address", + "base": "{http://www.w3.org/2001/XMLSchema}token" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "IPv6 address" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "When a source-specific multicast address is configured, the device will process multicast data only from the specified source, in accordance with SSM principles defined in RFC 4607." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains configuration details for multicast settings." + }, + { + "name": "RTPPayloadType", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Defines the RTP payload type used for the audio stream.\n\t\t\t\t\t\t\tTo ensure compatibility, it is recommended to use dynamic payload types (96 and above), as specified in RFC 3551.\n\t\t\t\t\t\t\tStandard payload types (0-95) should only be used for predefined audio formats matching the audio encoding as defined in\n\t\t\t\t\t\t\tIANA RTP Payload Types,\n\t\t\t\t\t\t\tas using them for non-standard media may lead to unexpected errors or interoperability issues." + }, + { + "name": "Priority", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates the priority level when multiple configurations are active.\n\t\t\t\t\t\t\t\tA higher value signifies a higher priority. If several configurations have the same priority value the order between those configurations is undefined." + }, + { + "name": "MediaFormatParameters", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional media format parameters as specified in SDP, such as:\n\t\t\t\t\t\t\t\ta=fmtp:101 stereo=1; sprop-stereo=1." + }, + { + "name": "SRTPPreSharedParameters", + "type": "{http://www.onvif.org/ver10/schema}SRTPPreShared", + "type_name": "SRTPPreShared", + "definition": { + "kind": "complexType", + "name": "SRTPPreShared", + "fields": [ + { + "name": "SRTPPSK", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "SRTP Pre-Shared Key (PSK) represented as a hexadecimal string.\n\t\t\t\tThis includes both the SRTP master key, followed by the master salt.\n\t\t\t\tThe sizes of the key and salt depend on the specified SecureStreamingProtocolAlgorithm.\n\t\t\t\tThe SRTPPSK shall be returned as an empty string on a get method.\n\t\t\t\tIn SetMulticastAudioDecoderConfiguration requests, if SRTPPreSharedParameters is present but \n\t\t\t\tSRTPPSK is empty, the device shall retain the previously configured pre-shared key.\n\t\t\t\tTo update the PSK, a valid non-empty hexadecimal value must be provided." + }, + { + "name": "ROCExtMapID", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The RTP header extension ID (ExtMapID) used to identify the ROC extension, as defined in RFC 8285.\n\t\t\t\tValid values are 1 to 14 for one-byte header extensions." + } + ], + "attributes": [ + { + "use": "optional", + "name": "SecureStreamingProtocolAlgorithm", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "description": "Specifies the cryptographic algorithm when using SRTP,\n\t\t\t\tselecting from predefined values provided in the GetMulticastAudioDecoderConfigurationOptions response." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional configuration parameters for SRTP pre-shared key usage, applicable when SRTP is supported. When this configuration is present, RTP packets shall be encrypted.\n\t\t\t\t\t\t\t\t When this configuration is absent, RTP packets shall not be encrypted. \n\t\t\t\t\t\t\t\tOn GetMulticastAudioDecoderConfiguration, this element shall be present only if encryption is enabled; it shall be absent if encryption is disabled." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the modified multicast audio decoder configuration. The configuration shall exist in the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/media/wsdl}SetMulticastAudioDecoderConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/media/wsdl}SetMulticastAudioDecoderConfigurationResponse", + "schema": { + "name": "SetMulticastAudioDecoderConfigurationResponse", + "type": "{http://www.onvif.org/ver20/media/wsdl}SetConfigurationResponse", + "type_name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "name": "SetConfigurationResponse", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "Media2Binding" + } + ] +} diff --git a/docs/generated/wsdl/ver20/ptz/wsdl/ptz.json b/docs/generated/wsdl/ver20/ptz/wsdl/ptz.json new file mode 100644 index 00000000..f7386e68 --- /dev/null +++ b/docs/generated/wsdl/ver20/ptz/wsdl/ptz.json @@ -0,0 +1,10794 @@ +{ + "source": "ver20/ptz/wsdl/ptz.wsdl", + "target_namespace": "http://www.onvif.org/ver20/ptz/wsdl", + "operations": [ + { + "name": "GetServiceCapabilities", + "port_type": "PTZ", + "description": "Returns the capabilities of the PTZ service. The result is returned in a typed answer.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetServiceCapabilitiesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetServiceCapabilities", + "schema": { + "name": "GetServiceCapabilities", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetServiceCapabilitiesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetServiceCapabilitiesResponse", + "schema": { + "name": "GetServiceCapabilitiesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Capabilities", + "type": "{http://www.onvif.org/ver20/ptz/wsdl}Capabilities", + "type_name": "Capabilities", + "definition": { + "kind": "complexType", + "name": "Capabilities", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "EFlip", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not EFlip is supported." + }, + { + "use": "optional", + "name": "Reverse", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates whether or not reversing of PT control direction is supported." + }, + { + "use": "optional", + "name": "GetCompatibleConfigurations", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates support for the GetCompatibleConfigurations command." + }, + { + "use": "optional", + "name": "MoveStatus", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that the PTZStatus includes MoveStatus information." + }, + { + "use": "optional", + "name": "StatusPosition", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indicates that the PTZStatus includes Position information." + }, + { + "use": "optional", + "name": "MoveAndTrack", + "type": "{http://www.onvif.org/ver10/schema}StringList", + "definition": { + "kind": "simpleType", + "name": "StringList", + "item_type": "{http://www.w3.org/2001/XMLSchema}string" + }, + "description": "Indication of the methods of MoveAndTrack that are supported, acceptable values are defined in tt:MoveAndTrackMethod." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The capabilities for the PTZ service is returned in the Capabilities element." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GetNodes", + "port_type": "PTZ", + "description": "Get the descriptions of the available PTZ Nodes. A PTZ-capable device may have multiple PTZ Nodes. The PTZ Nodes may represent mechanical PTZ drivers, uploaded PTZ drivers or digital PTZ drivers. PTZ Nodes are the lowest level entities in the PTZ control API and reflect the supported PTZ capabilities. The PTZ Node is referenced either by its name or by its reference token.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetNodesRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetNodes", + "schema": { + "name": "GetNodes", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetNodesResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetNodesResponse", + "schema": { + "name": "GetNodesResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PTZNode", + "type": "{http://www.onvif.org/ver10/schema}PTZNode", + "type_name": "PTZNode", + "definition": { + "kind": "complexType", + "name": "PTZNode", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A unique identifier that is used to reference PTZ Nodes." + }, + { + "name": "SupportedPTZSpaces", + "type": "{http://www.onvif.org/ver10/schema}PTZSpaces", + "type_name": "PTZSpaces", + "definition": { + "kind": "complexType", + "name": "PTZSpaces", + "fields": [ + { + "name": "AbsolutePanTiltPositionSpace", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Generic Pan/Tilt Position space is provided by every PTZ node that supports absolute Pan/Tilt, since it does not relate to a specific physical range.\n\t\t\tInstead, the range should be defined as the full range of the PTZ unit normalized to the range -1 to 1 resulting in the following space description." + }, + { + "name": "AbsoluteZoomPositionSpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Generic Zoom Position Space is provided by every PTZ node that supports absolute Zoom, since it does not relate to a specific physical range.\n\t\t\tInstead, the range should be defined as the full range of the Zoom normalized to the range 0 (wide) to 1 (tele).\n\t\t\tThere is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension." + }, + { + "name": "RelativePanTiltTranslationSpace", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Generic Pan/Tilt translation space is provided by every PTZ node that supports relative Pan/Tilt, since it does not relate to a specific physical range.\n\t\t\tInstead, the range should be defined as the full positive and negative translation range of the PTZ unit normalized to the range -1 to 1,\n\t\t\twhere positive translation would mean clockwise rotation or movement in right/up direction resulting in the following space description." + }, + { + "name": "RelativeZoomTranslationSpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Generic Zoom Translation Space is provided by every PTZ node that supports relative Zoom, since it does not relate to a specific physical range.\n\t\t\tInstead, the corresponding absolute range should be defined as the full positive and negative translation range of the Zoom normalized to the range -1 to1,\n\t\t\twhere a positive translation maps to a movement in TELE direction. The translation is signed to indicate direction (negative is to wide, positive is to tele).\n\t\t\tThere is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension. This results in the following space description." + }, + { + "name": "ContinuousPanTiltVelocitySpace", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The generic Pan/Tilt velocity space shall be provided by every PTZ node, since it does not relate to a specific physical range.\n\t\t\tInstead, the range should be defined as a range of the PTZ unit's speed normalized to the range -1 to 1, where a positive velocity would map to clockwise\n\t\t\trotation or movement in the right/up direction. A signed speed can be independently specified for the pan and tilt component resulting in the following space description." + }, + { + "name": "ContinuousZoomVelocitySpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The generic zoom velocity space specifies a zoom factor velocity without knowing the underlying physical model. The range should be normalized from -1 to 1,\n\t\t\twhere a positive velocity would map to TELE direction. A generic zoom velocity space description resembles the following." + }, + { + "name": "PanTiltSpeedSpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The speed space specifies the speed for a Pan/Tilt movement when moving to an absolute position or to a relative translation.\n\t\t\tIn contrast to the velocity spaces, speed spaces do not contain any directional information. The speed of a combined Pan/Tilt\n\t\t\tmovement is represented by a single non-negative scalar value." + }, + { + "name": "ZoomSpeedSpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The speed space specifies the speed for a Zoom movement when moving to an absolute position or to a relative translation.\n\t\t\tIn contrast to the velocity spaces, speed spaces do not contain any directional information." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZSpacesExtension", + "type_name": "PTZSpacesExtension", + "definition": { + "kind": "complexType", + "name": "PTZSpacesExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A list of Coordinate Systems available for the PTZ Node. For each Coordinate System, the PTZ Node MUST specify its allowed range." + }, + { + "name": "MaximumNumberOfPresets", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "All preset operations MUST be available for this PTZ Node if one preset is supported." + }, + { + "name": "HomeSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A boolean operator specifying the availability of a home position. If set to true, the Home Position Operations MUST be available for this PTZ Node." + }, + { + "name": "AuxiliaryCommands", + "type": "{http://www.onvif.org/ver10/schema}AuxiliaryData", + "type_name": "AuxiliaryData", + "definition": { + "kind": "simpleType", + "name": "AuxiliaryData", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "128" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of supported Auxiliary commands. If the list is not empty, the Auxiliary Operations MUST be available for this PTZ Node." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZNodeExtension", + "type_name": "PTZNodeExtension", + "definition": { + "kind": "complexType", + "name": "PTZNodeExtension", + "fields": [ + { + "name": "SupportedPresetTour", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSupported", + "type_name": "PTZPresetTourSupported", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSupported", + "fields": [ + { + "name": "MaximumNumberOfPresetTours", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates number of preset tours that can be created. Required preset tour operations shall be available for this PTZ Node if one or more preset tour is supported." + }, + { + "name": "PTZPresetTourOperation", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourOperation", + "type_name": "PTZPresetTourOperation", + "definition": { + "kind": "simpleType", + "name": "PTZPresetTourOperation", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Start" + }, + { + "value": "Stop" + }, + { + "value": "Pause" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Indicates which preset tour operations are available for this PTZ Node." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSupportedExtension", + "type_name": "PTZPresetTourSupportedExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSupportedExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Detail of supported Preset Tour feature." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZNodeExtension2", + "type_name": "PTZNodeExtension2", + "definition": { + "kind": "complexType", + "name": "PTZNodeExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "FixedHomePosition", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication whether the HomePosition of a Node is fixed or it can be changed via the SetHomePosition command." + }, + { + "use": "optional", + "name": "GeoMove", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication whether the Node supports the geo-referenced move command." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of the existing PTZ Nodes on the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GetNode", + "port_type": "PTZ", + "description": "Get a specific PTZ Node identified by a reference token or a name.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetNodeRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetNode", + "schema": { + "name": "GetNode", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "NodeToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested PTZNode." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetNodeResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetNodeResponse", + "schema": { + "name": "GetNodeResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PTZNode", + "type": "{http://www.onvif.org/ver10/schema}PTZNode", + "type_name": "PTZNode", + "definition": { + "kind": "complexType", + "name": "PTZNode", + "base": "{http://www.onvif.org/ver10/schema}DeviceEntity", + "base_definition": { + "kind": "complexType", + "name": "DeviceEntity", + "description": "Base class for physical entities like inputs and outputs.", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier referencing the physical entity." + } + ] + }, + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A unique identifier that is used to reference PTZ Nodes." + }, + { + "name": "SupportedPTZSpaces", + "type": "{http://www.onvif.org/ver10/schema}PTZSpaces", + "type_name": "PTZSpaces", + "definition": { + "kind": "complexType", + "name": "PTZSpaces", + "fields": [ + { + "name": "AbsolutePanTiltPositionSpace", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Generic Pan/Tilt Position space is provided by every PTZ node that supports absolute Pan/Tilt, since it does not relate to a specific physical range.\n\t\t\tInstead, the range should be defined as the full range of the PTZ unit normalized to the range -1 to 1 resulting in the following space description." + }, + { + "name": "AbsoluteZoomPositionSpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Generic Zoom Position Space is provided by every PTZ node that supports absolute Zoom, since it does not relate to a specific physical range.\n\t\t\tInstead, the range should be defined as the full range of the Zoom normalized to the range 0 (wide) to 1 (tele).\n\t\t\tThere is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension." + }, + { + "name": "RelativePanTiltTranslationSpace", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Generic Pan/Tilt translation space is provided by every PTZ node that supports relative Pan/Tilt, since it does not relate to a specific physical range.\n\t\t\tInstead, the range should be defined as the full positive and negative translation range of the PTZ unit normalized to the range -1 to 1,\n\t\t\twhere positive translation would mean clockwise rotation or movement in right/up direction resulting in the following space description." + }, + { + "name": "RelativeZoomTranslationSpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Generic Zoom Translation Space is provided by every PTZ node that supports relative Zoom, since it does not relate to a specific physical range.\n\t\t\tInstead, the corresponding absolute range should be defined as the full positive and negative translation range of the Zoom normalized to the range -1 to1,\n\t\t\twhere a positive translation maps to a movement in TELE direction. The translation is signed to indicate direction (negative is to wide, positive is to tele).\n\t\t\tThere is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension. This results in the following space description." + }, + { + "name": "ContinuousPanTiltVelocitySpace", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The generic Pan/Tilt velocity space shall be provided by every PTZ node, since it does not relate to a specific physical range.\n\t\t\tInstead, the range should be defined as a range of the PTZ unit's speed normalized to the range -1 to 1, where a positive velocity would map to clockwise\n\t\t\trotation or movement in the right/up direction. A signed speed can be independently specified for the pan and tilt component resulting in the following space description." + }, + { + "name": "ContinuousZoomVelocitySpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The generic zoom velocity space specifies a zoom factor velocity without knowing the underlying physical model. The range should be normalized from -1 to 1,\n\t\t\twhere a positive velocity would map to TELE direction. A generic zoom velocity space description resembles the following." + }, + { + "name": "PanTiltSpeedSpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The speed space specifies the speed for a Pan/Tilt movement when moving to an absolute position or to a relative translation.\n\t\t\tIn contrast to the velocity spaces, speed spaces do not contain any directional information. The speed of a combined Pan/Tilt\n\t\t\tmovement is represented by a single non-negative scalar value." + }, + { + "name": "ZoomSpeedSpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The speed space specifies the speed for a Zoom movement when moving to an absolute position or to a relative translation.\n\t\t\tIn contrast to the velocity spaces, speed spaces do not contain any directional information." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZSpacesExtension", + "type_name": "PTZSpacesExtension", + "definition": { + "kind": "complexType", + "name": "PTZSpacesExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A list of Coordinate Systems available for the PTZ Node. For each Coordinate System, the PTZ Node MUST specify its allowed range." + }, + { + "name": "MaximumNumberOfPresets", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "All preset operations MUST be available for this PTZ Node if one preset is supported." + }, + { + "name": "HomeSupported", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A boolean operator specifying the availability of a home position. If set to true, the Home Position Operations MUST be available for this PTZ Node." + }, + { + "name": "AuxiliaryCommands", + "type": "{http://www.onvif.org/ver10/schema}AuxiliaryData", + "type_name": "AuxiliaryData", + "definition": { + "kind": "simpleType", + "name": "AuxiliaryData", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "128" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of supported Auxiliary commands. If the list is not empty, the Auxiliary Operations MUST be available for this PTZ Node." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZNodeExtension", + "type_name": "PTZNodeExtension", + "definition": { + "kind": "complexType", + "name": "PTZNodeExtension", + "fields": [ + { + "name": "SupportedPresetTour", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSupported", + "type_name": "PTZPresetTourSupported", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSupported", + "fields": [ + { + "name": "MaximumNumberOfPresetTours", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates number of preset tours that can be created. Required preset tour operations shall be available for this PTZ Node if one or more preset tour is supported." + }, + { + "name": "PTZPresetTourOperation", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourOperation", + "type_name": "PTZPresetTourOperation", + "definition": { + "kind": "simpleType", + "name": "PTZPresetTourOperation", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Start" + }, + { + "value": "Stop" + }, + { + "value": "Pause" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Indicates which preset tour operations are available for this PTZ Node." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSupportedExtension", + "type_name": "PTZPresetTourSupportedExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSupportedExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Detail of supported Preset Tour feature." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZNodeExtension2", + "type_name": "PTZNodeExtension2", + "definition": { + "kind": "complexType", + "name": "PTZNodeExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "FixedHomePosition", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication whether the HomePosition of a Node is fixed or it can be changed via the SetHomePosition command." + }, + { + "use": "optional", + "name": "GeoMove", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Indication whether the Node supports the geo-referenced move command." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A requested PTZNode." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GetConfiguration", + "port_type": "PTZ", + "description": "Get a specific PTZconfiguration from the device, identified by its reference token or name. The default Position/Translation/Velocity Spaces are introduced to allow NVCs sending move requests without the need to specify a certain coordinate system. The default Speeds are introduced to control the speed of move requests (absolute, relative, preset), where no explicit speed has been set. The allowed pan and tilt range for Pan/Tilt Limits is defined by a two-dimensional space range that is mapped to a specific Absolute Pan/Tilt Position Space. At least one Pan/Tilt Position Space is required by the PTZNode to support Pan/Tilt limits. The limits apply to all supported absolute, relative and continuous Pan/Tilt movements. The limits shall be checked within the coordinate system for which the limits have been specified. That means that even if movements are specified in a different coordinate system, the requested movements shall be transformed to the coordinate system of the limits where the limits can be checked. When a relative or continuous movements is specified, which would leave the specified limits, the PTZ unit has to move along the specified limits. The Zoom Limits have to be interpreted accordingly.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetConfiguration", + "schema": { + "name": "GetConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PTZConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of the requested PTZConfiguration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetConfigurationResponse", + "schema": { + "name": "GetConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PTZConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PTZConfiguration", + "type_name": "PTZConfiguration", + "definition": { + "kind": "complexType", + "name": "PTZConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "NodeToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A mandatory reference to the PTZ Node that the PTZ Configuration belongs to." + }, + { + "name": "DefaultAbsolutePantTiltPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default." + }, + { + "name": "DefaultAbsoluteZoomPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default." + }, + { + "name": "DefaultRelativePanTiltTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default." + }, + { + "name": "DefaultRelativeZoomTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default." + }, + { + "name": "DefaultContinuousPanTiltVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default." + }, + { + "name": "DefaultContinuousZoomVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default." + }, + { + "name": "DefaultPTZSpeed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds." + }, + { + "name": "DefaultPTZTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops." + }, + { + "name": "PanTiltLimits", + "type": "{http://www.onvif.org/ver10/schema}PanTiltLimits", + "type_name": "PanTiltLimits", + "definition": { + "kind": "complexType", + "name": "PanTiltLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of pan tilt limits." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Pan/Tilt limits element should be present for a PTZ Node that supports an absolute Pan/Tilt. If the element is present it signals the support for configurable Pan/Tilt limits. If limits are enabled, the Pan/Tilt movements shall always stay within the specified range. The Pan/Tilt limits are disabled by setting the limits to -INF or +INF." + }, + { + "name": "ZoomLimits", + "type": "{http://www.onvif.org/ver10/schema}ZoomLimits", + "type_name": "ZoomLimits", + "definition": { + "kind": "complexType", + "name": "ZoomLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of zoom limit" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Zoom limits element should be present for a PTZ Node that supports absolute zoom. If the element is present it signals the supports for configurable Zoom limits. If limits are enabled the zoom movements shall always stay within the specified range. The Zoom limits are disabled by settings the limits to -INF and +INF." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension", + "type_name": "PTZConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension", + "fields": [ + { + "name": "PTControlDirection", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirection", + "type_name": "PTControlDirection", + "definition": { + "kind": "complexType", + "name": "PTControlDirection", + "fields": [ + { + "name": "EFlip", + "type": "{http://www.onvif.org/ver10/schema}EFlip", + "type_name": "EFlip", + "definition": { + "kind": "complexType", + "name": "EFlip", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}EFlipMode", + "type_name": "EFlipMode", + "definition": { + "kind": "simpleType", + "name": "EFlipMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable E-Flip feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for E-Flip." + }, + { + "name": "Reverse", + "type": "{http://www.onvif.org/ver10/schema}Reverse", + "type_name": "Reverse", + "definition": { + "kind": "complexType", + "name": "Reverse", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReverseMode", + "type_name": "ReverseMode", + "definition": { + "kind": "simpleType", + "name": "ReverseMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "AUTO" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Reverse feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for reversing of PT Control Direction." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirectionExtension", + "type_name": "PTControlDirectionExtension", + "definition": { + "kind": "complexType", + "name": "PTControlDirectionExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure PT Control Direction related features." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension2", + "type_name": "PTZConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "MoveRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when moving." + }, + { + "use": "optional", + "name": "PresetRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when recalling presets." + }, + { + "use": "optional", + "name": "PresetTourRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when executing PresetTours." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A requested PTZConfiguration." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GetConfigurations", + "port_type": "PTZ", + "description": "Get all the existing PTZConfigurations from the device. The default Position/Translation/Velocity Spaces are introduced to allow NVCs sending move requests without the need to specify a certain coordinate system. The default Speeds are introduced to control the speed of move requests (absolute, relative, preset), where no explicit speed has been set. The allowed pan and tilt range for Pan/Tilt Limits is defined by a two-dimensional space range that is mapped to a specific Absolute Pan/Tilt Position Space. At least one Pan/Tilt Position Space is required by the PTZNode to support Pan/Tilt limits. The limits apply to all supported absolute, relative and continuous Pan/Tilt movements. The limits shall be checked within the coordinate system for which the limits have been specified. That means that even if movements are specified in a different coordinate system, the requested movements shall be transformed to the coordinate system of the limits where the limits can be checked. When a relative or continuous movements is specified, which would leave the specified limits, the PTZ unit has to move along the specified limits. The Zoom Limits have to be interpreted accordingly.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetConfigurations", + "schema": { + "name": "GetConfigurations", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetConfigurationsResponse", + "schema": { + "name": "GetConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PTZConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PTZConfiguration", + "type_name": "PTZConfiguration", + "definition": { + "kind": "complexType", + "name": "PTZConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "NodeToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A mandatory reference to the PTZ Node that the PTZ Configuration belongs to." + }, + { + "name": "DefaultAbsolutePantTiltPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default." + }, + { + "name": "DefaultAbsoluteZoomPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default." + }, + { + "name": "DefaultRelativePanTiltTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default." + }, + { + "name": "DefaultRelativeZoomTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default." + }, + { + "name": "DefaultContinuousPanTiltVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default." + }, + { + "name": "DefaultContinuousZoomVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default." + }, + { + "name": "DefaultPTZSpeed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds." + }, + { + "name": "DefaultPTZTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops." + }, + { + "name": "PanTiltLimits", + "type": "{http://www.onvif.org/ver10/schema}PanTiltLimits", + "type_name": "PanTiltLimits", + "definition": { + "kind": "complexType", + "name": "PanTiltLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of pan tilt limits." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Pan/Tilt limits element should be present for a PTZ Node that supports an absolute Pan/Tilt. If the element is present it signals the support for configurable Pan/Tilt limits. If limits are enabled, the Pan/Tilt movements shall always stay within the specified range. The Pan/Tilt limits are disabled by setting the limits to -INF or +INF." + }, + { + "name": "ZoomLimits", + "type": "{http://www.onvif.org/ver10/schema}ZoomLimits", + "type_name": "ZoomLimits", + "definition": { + "kind": "complexType", + "name": "ZoomLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of zoom limit" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Zoom limits element should be present for a PTZ Node that supports absolute zoom. If the element is present it signals the supports for configurable Zoom limits. If limits are enabled the zoom movements shall always stay within the specified range. The Zoom limits are disabled by settings the limits to -INF and +INF." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension", + "type_name": "PTZConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension", + "fields": [ + { + "name": "PTControlDirection", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirection", + "type_name": "PTControlDirection", + "definition": { + "kind": "complexType", + "name": "PTControlDirection", + "fields": [ + { + "name": "EFlip", + "type": "{http://www.onvif.org/ver10/schema}EFlip", + "type_name": "EFlip", + "definition": { + "kind": "complexType", + "name": "EFlip", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}EFlipMode", + "type_name": "EFlipMode", + "definition": { + "kind": "simpleType", + "name": "EFlipMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable E-Flip feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for E-Flip." + }, + { + "name": "Reverse", + "type": "{http://www.onvif.org/ver10/schema}Reverse", + "type_name": "Reverse", + "definition": { + "kind": "complexType", + "name": "Reverse", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReverseMode", + "type_name": "ReverseMode", + "definition": { + "kind": "simpleType", + "name": "ReverseMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "AUTO" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Reverse feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for reversing of PT Control Direction." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirectionExtension", + "type_name": "PTControlDirectionExtension", + "definition": { + "kind": "complexType", + "name": "PTControlDirectionExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure PT Control Direction related features." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension2", + "type_name": "PTZConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "MoveRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when moving." + }, + { + "use": "optional", + "name": "PresetRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when recalling presets." + }, + { + "use": "optional", + "name": "PresetTourRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when executing PresetTours." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of all existing PTZConfigurations on the device." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "SetConfiguration", + "port_type": "PTZ", + "description": "Set/update a existing PTZConfiguration on the device.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}SetConfigurationRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}SetConfiguration", + "schema": { + "name": "SetConfiguration", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PTZConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PTZConfiguration", + "type_name": "PTZConfiguration", + "definition": { + "kind": "complexType", + "name": "PTZConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "NodeToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A mandatory reference to the PTZ Node that the PTZ Configuration belongs to." + }, + { + "name": "DefaultAbsolutePantTiltPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default." + }, + { + "name": "DefaultAbsoluteZoomPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default." + }, + { + "name": "DefaultRelativePanTiltTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default." + }, + { + "name": "DefaultRelativeZoomTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default." + }, + { + "name": "DefaultContinuousPanTiltVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default." + }, + { + "name": "DefaultContinuousZoomVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default." + }, + { + "name": "DefaultPTZSpeed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds." + }, + { + "name": "DefaultPTZTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops." + }, + { + "name": "PanTiltLimits", + "type": "{http://www.onvif.org/ver10/schema}PanTiltLimits", + "type_name": "PanTiltLimits", + "definition": { + "kind": "complexType", + "name": "PanTiltLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of pan tilt limits." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Pan/Tilt limits element should be present for a PTZ Node that supports an absolute Pan/Tilt. If the element is present it signals the support for configurable Pan/Tilt limits. If limits are enabled, the Pan/Tilt movements shall always stay within the specified range. The Pan/Tilt limits are disabled by setting the limits to -INF or +INF." + }, + { + "name": "ZoomLimits", + "type": "{http://www.onvif.org/ver10/schema}ZoomLimits", + "type_name": "ZoomLimits", + "definition": { + "kind": "complexType", + "name": "ZoomLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of zoom limit" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Zoom limits element should be present for a PTZ Node that supports absolute zoom. If the element is present it signals the supports for configurable Zoom limits. If limits are enabled the zoom movements shall always stay within the specified range. The Zoom limits are disabled by settings the limits to -INF and +INF." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension", + "type_name": "PTZConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension", + "fields": [ + { + "name": "PTControlDirection", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirection", + "type_name": "PTControlDirection", + "definition": { + "kind": "complexType", + "name": "PTControlDirection", + "fields": [ + { + "name": "EFlip", + "type": "{http://www.onvif.org/ver10/schema}EFlip", + "type_name": "EFlip", + "definition": { + "kind": "complexType", + "name": "EFlip", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}EFlipMode", + "type_name": "EFlipMode", + "definition": { + "kind": "simpleType", + "name": "EFlipMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable E-Flip feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for E-Flip." + }, + { + "name": "Reverse", + "type": "{http://www.onvif.org/ver10/schema}Reverse", + "type_name": "Reverse", + "definition": { + "kind": "complexType", + "name": "Reverse", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReverseMode", + "type_name": "ReverseMode", + "definition": { + "kind": "simpleType", + "name": "ReverseMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "AUTO" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Reverse feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for reversing of PT Control Direction." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirectionExtension", + "type_name": "PTControlDirectionExtension", + "definition": { + "kind": "complexType", + "name": "PTControlDirectionExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure PT Control Direction related features." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension2", + "type_name": "PTZConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "MoveRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when moving." + }, + { + "use": "optional", + "name": "PresetRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when recalling presets." + }, + { + "use": "optional", + "name": "PresetTourRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when executing PresetTours." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "ForcePersistence", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Flag that makes configuration persistent. Example: User wants the configuration to exist after reboot." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}SetConfigurationResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}SetConfigurationResponse", + "schema": { + "name": "SetConfigurationResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GetConfigurationOptions", + "port_type": "PTZ", + "description": "List supported coordinate systems including their range limitations. Therefore, the options MAY differ depending on whether the PTZ Configuration is assigned to a Profile containing a Video Source Configuration. In that case, the options may additionally contain coordinate systems referring to the image coordinate system described by the Video Source Configuration. If the PTZ Node supports continuous movements, it shall return a Timeout Range within which Timeouts are accepted by the PTZ Node.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetConfigurationOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetConfigurationOptions", + "schema": { + "name": "GetConfigurationOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ConfigurationToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Token of an existing configuration that the options are intended for." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetConfigurationOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetConfigurationOptionsResponse", + "schema": { + "name": "GetConfigurationOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PTZConfigurationOptions", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationOptions", + "type_name": "PTZConfigurationOptions", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationOptions", + "fields": [ + { + "name": "Spaces", + "type": "{http://www.onvif.org/ver10/schema}PTZSpaces", + "type_name": "PTZSpaces", + "definition": { + "kind": "complexType", + "name": "PTZSpaces", + "fields": [ + { + "name": "AbsolutePanTiltPositionSpace", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Generic Pan/Tilt Position space is provided by every PTZ node that supports absolute Pan/Tilt, since it does not relate to a specific physical range.\n\t\t\tInstead, the range should be defined as the full range of the PTZ unit normalized to the range -1 to 1 resulting in the following space description." + }, + { + "name": "AbsoluteZoomPositionSpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Generic Zoom Position Space is provided by every PTZ node that supports absolute Zoom, since it does not relate to a specific physical range.\n\t\t\tInstead, the range should be defined as the full range of the Zoom normalized to the range 0 (wide) to 1 (tele).\n\t\t\tThere is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension." + }, + { + "name": "RelativePanTiltTranslationSpace", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Generic Pan/Tilt translation space is provided by every PTZ node that supports relative Pan/Tilt, since it does not relate to a specific physical range.\n\t\t\tInstead, the range should be defined as the full positive and negative translation range of the PTZ unit normalized to the range -1 to 1,\n\t\t\twhere positive translation would mean clockwise rotation or movement in right/up direction resulting in the following space description." + }, + { + "name": "RelativeZoomTranslationSpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The Generic Zoom Translation Space is provided by every PTZ node that supports relative Zoom, since it does not relate to a specific physical range.\n\t\t\tInstead, the corresponding absolute range should be defined as the full positive and negative translation range of the Zoom normalized to the range -1 to1,\n\t\t\twhere a positive translation maps to a movement in TELE direction. The translation is signed to indicate direction (negative is to wide, positive is to tele).\n\t\t\tThere is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension. This results in the following space description." + }, + { + "name": "ContinuousPanTiltVelocitySpace", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The generic Pan/Tilt velocity space shall be provided by every PTZ node, since it does not relate to a specific physical range.\n\t\t\tInstead, the range should be defined as a range of the PTZ unit's speed normalized to the range -1 to 1, where a positive velocity would map to clockwise\n\t\t\trotation or movement in the right/up direction. A signed speed can be independently specified for the pan and tilt component resulting in the following space description." + }, + { + "name": "ContinuousZoomVelocitySpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The generic zoom velocity space specifies a zoom factor velocity without knowing the underlying physical model. The range should be normalized from -1 to 1,\n\t\t\twhere a positive velocity would map to TELE direction. A generic zoom velocity space description resembles the following." + }, + { + "name": "PanTiltSpeedSpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The speed space specifies the speed for a Pan/Tilt movement when moving to an absolute position or to a relative translation.\n\t\t\tIn contrast to the velocity spaces, speed spaces do not contain any directional information. The speed of a combined Pan/Tilt\n\t\t\tmovement is represented by a single non-negative scalar value." + }, + { + "name": "ZoomSpeedSpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "The speed space specifies the speed for a Zoom movement when moving to an absolute position or to a relative translation.\n\t\t\tIn contrast to the velocity spaces, speed spaces do not contain any directional information." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZSpacesExtension", + "type_name": "PTZSpacesExtension", + "definition": { + "kind": "complexType", + "name": "PTZSpacesExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A list of supported coordinate systems including their range limitations." + }, + { + "name": "PTZTimeout", + "type": "{http://www.onvif.org/ver10/schema}DurationRange", + "type_name": "DurationRange", + "definition": { + "kind": "complexType", + "name": "DurationRange", + "description": "Range of duration greater equal Min duration and less equal Max duration.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A timeout Range within which Timeouts are accepted by the PTZ Node." + }, + { + "name": "PTControlDirection", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirectionOptions", + "type_name": "PTControlDirectionOptions", + "definition": { + "kind": "complexType", + "name": "PTControlDirectionOptions", + "fields": [ + { + "name": "EFlip", + "type": "{http://www.onvif.org/ver10/schema}EFlipOptions", + "type_name": "EFlipOptions", + "definition": { + "kind": "complexType", + "name": "EFlipOptions", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}EFlipMode", + "type_name": "EFlipMode", + "definition": { + "kind": "simpleType", + "name": "EFlipMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Options of EFlip mode parameter." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}EFlipOptionsExtension", + "type_name": "EFlipOptionsExtension", + "definition": { + "kind": "complexType", + "name": "EFlipOptionsExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Supported options for EFlip feature." + }, + { + "name": "Reverse", + "type": "{http://www.onvif.org/ver10/schema}ReverseOptions", + "type_name": "ReverseOptions", + "definition": { + "kind": "complexType", + "name": "ReverseOptions", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReverseMode", + "type_name": "ReverseMode", + "definition": { + "kind": "simpleType", + "name": "ReverseMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "AUTO" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Options of Reverse mode parameter." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}ReverseOptionsExtension", + "type_name": "ReverseOptionsExtension", + "definition": { + "kind": "complexType", + "name": "ReverseOptionsExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Supported options for Reverse feature." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirectionOptionsExtension", + "type_name": "PTControlDirectionOptionsExtension", + "definition": { + "kind": "complexType", + "name": "PTControlDirectionOptionsExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Supported options for PT Direction Control." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationOptions2", + "type_name": "PTZConfigurationOptions2", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationOptions2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "PTZRamps", + "type": "{http://www.onvif.org/ver10/schema}IntList", + "definition": { + "kind": "simpleType", + "name": "IntList", + "item_type": "{http://www.w3.org/2001/XMLSchema}int" + }, + "description": "The list of acceleration ramps supported by the device. The\n\t\t\t\t\tsmallest acceleration value corresponds to the minimal index, the\n\t\t\t\t\thighest acceleration corresponds to the maximum index." + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The requested PTZ configuration options." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "SendAuxiliaryCommand", + "port_type": "PTZ", + "description": "Operation to send auxiliary commands to the PTZ device mapped by the PTZNode in the selected profile. The operation is supported if the AuxiliarySupported element of the PTZNode is true", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}SendAuxiliaryCommandRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}SendAuxiliaryCommand", + "schema": { + "name": "SendAuxiliaryCommand", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile where the operation should take place." + }, + { + "name": "AuxiliaryData", + "type": "{http://www.onvif.org/ver10/schema}AuxiliaryData", + "type_name": "AuxiliaryData", + "definition": { + "kind": "simpleType", + "name": "AuxiliaryData", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "128" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The Auxiliary request data." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}SendAuxiliaryCommandResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}SendAuxiliaryCommandResponse", + "schema": { + "name": "SendAuxiliaryCommandResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "AuxiliaryResponse", + "type": "{http://www.onvif.org/ver10/schema}AuxiliaryData", + "type_name": "AuxiliaryData", + "definition": { + "kind": "simpleType", + "name": "AuxiliaryData", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "128" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The response contains the auxiliary response." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GetPresets", + "port_type": "PTZ", + "description": "Operation to request all PTZ presets for the PTZNode in the selected profile. The operation is supported if there is support for at least on PTZ preset by the PTZNode.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresets", + "schema": { + "name": "GetPresets", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile where the operation should take place." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetsResponse", + "schema": { + "name": "GetPresetsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Preset", + "type": "{http://www.onvif.org/ver10/schema}PTZPreset", + "type_name": "PTZPreset", + "definition": { + "kind": "complexType", + "name": "PTZPreset", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A list of preset position name." + }, + { + "name": "PTZPosition", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A list of preset position." + } + ], + "attributes": [ + { + "use": "optional", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + } + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of presets which are available for the requested MediaProfile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "SetPreset", + "port_type": "PTZ", + "description": "The SetPreset command saves the current device position parameters so that the device can move to the saved preset position through the GotoPreset operation. In order to create a new preset, the SetPresetRequest contains no PresetToken. If creation is successful, the Response contains the PresetToken which uniquely identifies the Preset. An existing Preset can be overwritten by specifying the PresetToken of the corresponding Preset. In both cases (overwriting or creation) an optional PresetName can be specified. The operation fails if the PTZ device is moving during the SetPreset operation. The device MAY internally save additional states such as imaging properties in the PTZ Preset which then should be recalled in the GotoPreset operation.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}SetPresetRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}SetPreset", + "schema": { + "name": "SetPreset", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile where the operation should take place." + }, + { + "name": "PresetName", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A requested preset name." + }, + { + "name": "PresetToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A requested preset token." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}SetPresetResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}SetPresetResponse", + "schema": { + "name": "SetPresetResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PresetToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A token to the Preset which has been set." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "RemovePreset", + "port_type": "PTZ", + "description": "Operation to remove a PTZ preset for the Node in the selected profile. The operation is supported if the PresetPosition capability exists for teh Node in the selected profile.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}RemovePresetRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}RemovePreset", + "schema": { + "name": "RemovePreset", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile where the operation should take place." + }, + { + "name": "PresetToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A requested preset token." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}RemovePresetResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}RemovePresetResponse", + "schema": { + "name": "RemovePresetResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GotoPreset", + "port_type": "PTZ", + "description": "Operation to go to a saved preset position for the PTZNode in the selected profile. The operation is supported if there is support for at least on PTZ preset by the PTZNode.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GotoPresetRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GotoPreset", + "schema": { + "name": "GotoPreset", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile where the operation should take place." + }, + { + "name": "PresetToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A requested preset token." + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A requested speed.The speed parameter can only be specified when Speed Spaces are available for the PTZ Node." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GotoPresetResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GotoPresetResponse", + "schema": { + "name": "GotoPresetResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GotoHomePosition", + "port_type": "PTZ", + "description": "Operation to move the PTZ device to it's \"home\" position. The operation is supported if the HomeSupported element in the PTZNode is true.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GotoHomePositionRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GotoHomePosition", + "schema": { + "name": "GotoHomePosition", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile where the operation should take place." + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A requested speed.The speed parameter can only be specified when Speed Spaces are available for the PTZ Node." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GotoHomePositionResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GotoHomePositionResponse", + "schema": { + "name": "GotoHomePositionResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "SetHomePosition", + "port_type": "PTZ", + "description": "Operation to save current position as the home position. The SetHomePosition command returns with a failure if the \"home\" position is fixed and cannot be overwritten. If the SetHomePosition is successful, it is possible to recall the Home Position with the GotoHomePosition command.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}SetHomePositionRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}SetHomePosition", + "schema": { + "name": "SetHomePosition", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile where the home position should be set." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}SetHomePositionResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}SetHomePositionResponse", + "schema": { + "name": "SetHomePositionResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "ContinuousMove", + "port_type": "PTZ", + "description": "Operation for continuous Pan/Tilt and Zoom movements. The operation is supported if the PTZNode supports at least one continuous Pan/Tilt or Zoom space. If the space argument is omitted, the default space set by the PTZConfiguration will be used.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}ContinuousMoveRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}ContinuousMove", + "schema": { + "name": "ContinuousMove", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile." + }, + { + "name": "Velocity", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A Velocity vector specifying the velocity of pan, tilt and zoom." + }, + { + "name": "Timeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An optional Timeout parameter." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}ContinuousMoveResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}ContinuousMoveResponse", + "schema": { + "name": "ContinuousMoveResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "RelativeMove", + "port_type": "PTZ", + "description": "Operation for Relative Pan/Tilt and Zoom Move. The operation is supported if the PTZNode supports at least one relative Pan/Tilt or Zoom space. The speed argument is optional. If an x/y speed value is given it is up to the device to either use the x value as absolute resoluting speed vector or to map x and y to the component speed. If the speed argument is omitted, the default speed set by the PTZConfiguration will be used.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}RelativeMoveRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}RelativeMove", + "schema": { + "name": "RelativeMove", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile." + }, + { + "name": "Translation", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A positional Translation relative to the current position" + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An optional Speed parameter." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}RelativeMoveResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}RelativeMoveResponse", + "schema": { + "name": "RelativeMoveResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GetStatus", + "port_type": "PTZ", + "description": "Operation to request PTZ status for the Node in the selected profile.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetStatusRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetStatus", + "schema": { + "name": "GetStatus", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile where the PTZStatus should be requested." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetStatusResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetStatusResponse", + "schema": { + "name": "GetStatusResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PTZStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZStatus", + "type_name": "PTZStatus", + "definition": { + "kind": "complexType", + "name": "PTZStatus", + "fields": [ + { + "name": "Position", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the absolute position of the PTZ unit together with the Space references. The default absolute spaces of the corresponding PTZ configuration MUST be referenced within the Position element." + }, + { + "name": "MoveStatus", + "type": "{http://www.onvif.org/ver10/schema}PTZMoveStatus", + "type_name": "PTZMoveStatus", + "definition": { + "kind": "complexType", + "name": "PTZMoveStatus", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}MoveStatus", + "type_name": "MoveStatus", + "definition": { + "kind": "simpleType", + "name": "MoveStatus", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IDLE" + }, + { + "value": "MOVING" + }, + { + "value": "UNKNOWN" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}MoveStatus", + "type_name": "MoveStatus", + "definition": { + "kind": "simpleType", + "name": "MoveStatus", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "IDLE" + }, + { + "value": "MOVING" + }, + { + "value": "UNKNOWN" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates if the Pan/Tilt/Zoom device unit is currently moving, idle or in an unknown state." + }, + { + "name": "Error", + "type": "{http://www.w3.org/2001/XMLSchema}string", + "type_name": "string", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "States a current PTZ error." + }, + { + "name": "UtcTime", + "type": "{http://www.w3.org/2001/XMLSchema}dateTime", + "type_name": "dateTime", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Specifies the UTC time when this status was generated." + }, + { + "name": "FieldOfView", + "type": "{http://www.onvif.org/ver10/schema}FieldOfView", + "type_name": "FieldOfView", + "definition": { + "kind": "complexType", + "name": "FieldOfView", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "hfov", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Horizontal field-of-view in degrees." + }, + { + "use": "required", + "name": "vfov", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Vertical field-of-view in degrees." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "States the current field of view of the video stream." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The PTZStatus for the requested MediaProfile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "AbsoluteMove", + "port_type": "PTZ", + "description": "Operation to move pan,tilt or zoom to a absolute destination. The speed argument is optional. If an x/y speed value is given it is up to the device to either use the x value as absolute resoluting speed vector or to map x and y to the component speed. If the speed argument is omitted, the default speed set by the PTZConfiguration will be used.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}AbsoluteMoveRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}AbsoluteMove", + "schema": { + "name": "AbsoluteMove", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile." + }, + { + "name": "Position", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A Position vector specifying the absolute target position." + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An optional Speed." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}AbsoluteMoveResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}AbsoluteMoveResponse", + "schema": { + "name": "AbsoluteMoveResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GeoMove", + "port_type": "PTZ", + "description": "Operation to move pan,tilt or zoom to point to a destination based on the geolocation of the target. The speed argument is optional. If an x/y speed value is given it is up to the device to either use the x value as absolute resoluting speed vector or to map x and y to the component speed. If the speed argument is omitted, the default speed set by the PTZConfiguration will be used. The area height and area dwidth parameters are optional, they can be used independently and may be used by the device to automatically determine the best zoom level to show the target.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GeoMoveRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GeoMove", + "schema": { + "name": "GeoMove", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile." + }, + { + "name": "Target", + "type": "{http://www.onvif.org/ver10/schema}GeoLocation", + "type_name": "GeoLocation", + "definition": { + "kind": "complexType", + "name": "GeoLocation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "lon", + "type": "{http://www.w3.org/2001/XMLSchema}double", + "description": "East west location as angle." + }, + { + "use": "optional", + "name": "lat", + "type": "{http://www.w3.org/2001/XMLSchema}double", + "description": "North south location as angle." + }, + { + "use": "optional", + "name": "elevation", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Height in meters above sea level." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "The geolocation of the target position." + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An optional Speed." + }, + { + "name": "AreaHeight", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An optional indication of the height of the target/area." + }, + { + "name": "AreaWidth", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An optional indication of the width of the target/area." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GeoMoveResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GeoMoveResponse", + "schema": { + "name": "GeoMoveResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "Stop", + "port_type": "PTZ", + "description": "Operation to stop ongoing pan, tilt and zoom movements of absolute relative and continuous type. If no stop argument for pan, tilt or zoom is set, the device will stop all ongoing pan, tilt and zoom movements.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}StopRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}Stop", + "schema": { + "name": "Stop", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile that indicate what should be stopped." + }, + { + "name": "PanTilt", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Set true when we want to stop ongoing pan and tilt movements.If PanTilt arguments are not present, this command stops these movements." + }, + { + "name": "Zoom", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Set true when we want to stop ongoing zoom movement.If Zoom arguments are not present, this command stops ongoing zoom movement." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}StopResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}StopResponse", + "schema": { + "name": "StopResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GetPresetTours", + "port_type": "PTZ", + "description": "Operation to request PTZ preset tours in the selected media profiles.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetToursRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetTours", + "schema": { + "name": "GetPresetTours", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetToursResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetToursResponse", + "schema": { + "name": "GetPresetToursResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PresetTour", + "type": "{http://www.onvif.org/ver10/schema}PresetTour", + "type_name": "PresetTour", + "definition": { + "kind": "complexType", + "name": "PresetTour", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Readable name of the preset tour." + }, + { + "name": "Status", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStatus", + "type_name": "PTZPresetTourStatus", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStatus", + "fields": [ + { + "name": "State", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourState", + "type_name": "PTZPresetTourState", + "definition": { + "kind": "simpleType", + "name": "PTZPresetTourState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Idle" + }, + { + "value": "Touring" + }, + { + "value": "Paused" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates state of this preset tour by Idle/Touring/Paused." + }, + { + "name": "CurrentTourSpot", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSpot", + "type_name": "PTZPresetTourSpot", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSpot", + "fields": [ + { + "name": "PresetDetail", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourPresetDetail", + "type_name": "PTZPresetTourPresetDetail", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourPresetDetail", + "fields": [ + { + "name": "PresetToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with Preset Token defined in advance." + }, + { + "name": "Home", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with the home position of this PTZ Node. \"False\" to this parameter shall be treated as an invalid argument." + }, + { + "name": "PTZPosition", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with vector of PTZ node directly." + }, + { + "name": "TypeExtension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourTypeExtension", + "type_name": "PTZPresetTourTypeExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourTypeExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Detail definition of preset position of the tour spot." + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot." + }, + { + "name": "StayTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify time duration of staying on this tour sport." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSpotExtension", + "type_name": "PTZPresetTourSpotExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSpotExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates a tour spot currently staying." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStatusExtension", + "type_name": "PTZPresetTourStatusExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStatusExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only parameters to indicate the status of the preset tour." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Auto Start flag of the preset tour. True allows the preset tour to be activated always." + }, + { + "name": "StartingCondition", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStartingCondition", + "type_name": "PTZPresetTourStartingCondition", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStartingCondition", + "fields": [ + { + "name": "RecurringTime", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify how many times the preset tour is recurred." + }, + { + "name": "RecurringDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify how long time duration the preset tour is recurred." + }, + { + "name": "Direction", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourDirection", + "type_name": "PTZPresetTourDirection", + "definition": { + "kind": "simpleType", + "name": "PTZPresetTourDirection", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Forward" + }, + { + "value": "Backward" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to choose which direction the preset tour goes. Forward shall be chosen in case it is omitted." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStartingConditionExtension", + "type_name": "PTZPresetTourStartingConditionExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStartingConditionExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "RandomPresetOrder", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Execute presets in random order. If set to true and Direction is also present, Direction will be ignored and presets of the Tour will be recalled randomly." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameters to specify the detail behavior of the preset tour." + }, + { + "name": "TourSpot", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSpot", + "type_name": "PTZPresetTourSpot", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSpot", + "fields": [ + { + "name": "PresetDetail", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourPresetDetail", + "type_name": "PTZPresetTourPresetDetail", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourPresetDetail", + "fields": [ + { + "name": "PresetToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with Preset Token defined in advance." + }, + { + "name": "Home", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with the home position of this PTZ Node. \"False\" to this parameter shall be treated as an invalid argument." + }, + { + "name": "PTZPosition", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with vector of PTZ node directly." + }, + { + "name": "TypeExtension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourTypeExtension", + "type_name": "PTZPresetTourTypeExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourTypeExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Detail definition of preset position of the tour spot." + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot." + }, + { + "name": "StayTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify time duration of staying on this tour sport." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSpotExtension", + "type_name": "PTZPresetTourSpotExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSpotExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of detail of touring spots including preset positions." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourExtension", + "type_name": "PTZPresetTourExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of this preset tour." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GetPresetTour", + "port_type": "PTZ", + "description": "Operation to request a specific PTZ preset tour in the selected media profile.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetTourRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetTour", + "schema": { + "name": "GetPresetTour", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "PresetTourToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetTourResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetTourResponse", + "schema": { + "name": "GetPresetTourResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PresetTour", + "type": "{http://www.onvif.org/ver10/schema}PresetTour", + "type_name": "PresetTour", + "definition": { + "kind": "complexType", + "name": "PresetTour", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Readable name of the preset tour." + }, + { + "name": "Status", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStatus", + "type_name": "PTZPresetTourStatus", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStatus", + "fields": [ + { + "name": "State", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourState", + "type_name": "PTZPresetTourState", + "definition": { + "kind": "simpleType", + "name": "PTZPresetTourState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Idle" + }, + { + "value": "Touring" + }, + { + "value": "Paused" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates state of this preset tour by Idle/Touring/Paused." + }, + { + "name": "CurrentTourSpot", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSpot", + "type_name": "PTZPresetTourSpot", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSpot", + "fields": [ + { + "name": "PresetDetail", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourPresetDetail", + "type_name": "PTZPresetTourPresetDetail", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourPresetDetail", + "fields": [ + { + "name": "PresetToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with Preset Token defined in advance." + }, + { + "name": "Home", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with the home position of this PTZ Node. \"False\" to this parameter shall be treated as an invalid argument." + }, + { + "name": "PTZPosition", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with vector of PTZ node directly." + }, + { + "name": "TypeExtension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourTypeExtension", + "type_name": "PTZPresetTourTypeExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourTypeExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Detail definition of preset position of the tour spot." + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot." + }, + { + "name": "StayTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify time duration of staying on this tour sport." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSpotExtension", + "type_name": "PTZPresetTourSpotExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSpotExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates a tour spot currently staying." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStatusExtension", + "type_name": "PTZPresetTourStatusExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStatusExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only parameters to indicate the status of the preset tour." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Auto Start flag of the preset tour. True allows the preset tour to be activated always." + }, + { + "name": "StartingCondition", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStartingCondition", + "type_name": "PTZPresetTourStartingCondition", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStartingCondition", + "fields": [ + { + "name": "RecurringTime", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify how many times the preset tour is recurred." + }, + { + "name": "RecurringDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify how long time duration the preset tour is recurred." + }, + { + "name": "Direction", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourDirection", + "type_name": "PTZPresetTourDirection", + "definition": { + "kind": "simpleType", + "name": "PTZPresetTourDirection", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Forward" + }, + { + "value": "Backward" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to choose which direction the preset tour goes. Forward shall be chosen in case it is omitted." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStartingConditionExtension", + "type_name": "PTZPresetTourStartingConditionExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStartingConditionExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "RandomPresetOrder", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Execute presets in random order. If set to true and Direction is also present, Direction will be ignored and presets of the Tour will be recalled randomly." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameters to specify the detail behavior of the preset tour." + }, + { + "name": "TourSpot", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSpot", + "type_name": "PTZPresetTourSpot", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSpot", + "fields": [ + { + "name": "PresetDetail", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourPresetDetail", + "type_name": "PTZPresetTourPresetDetail", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourPresetDetail", + "fields": [ + { + "name": "PresetToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with Preset Token defined in advance." + }, + { + "name": "Home", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with the home position of this PTZ Node. \"False\" to this parameter shall be treated as an invalid argument." + }, + { + "name": "PTZPosition", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with vector of PTZ node directly." + }, + { + "name": "TypeExtension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourTypeExtension", + "type_name": "PTZPresetTourTypeExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourTypeExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Detail definition of preset position of the tour spot." + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot." + }, + { + "name": "StayTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify time duration of staying on this tour sport." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSpotExtension", + "type_name": "PTZPresetTourSpotExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSpotExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of detail of touring spots including preset positions." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourExtension", + "type_name": "PTZPresetTourExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of this preset tour." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GetPresetTourOptions", + "port_type": "PTZ", + "description": "Operation to request available options to configure PTZ preset tour.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetTourOptionsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetTourOptions", + "schema": { + "name": "GetPresetTourOptions", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "PresetTourToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetTourOptionsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetPresetTourOptionsResponse", + "schema": { + "name": "GetPresetTourOptionsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "Options", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourOptions", + "type_name": "PTZPresetTourOptions", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourOptions", + "fields": [ + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates whether or not the AutoStart is supported." + }, + { + "name": "StartingCondition", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStartingConditionOptions", + "type_name": "PTZPresetTourStartingConditionOptions", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStartingConditionOptions", + "fields": [ + { + "name": "RecurringTime", + "type": "{http://www.onvif.org/ver10/schema}IntRange", + "type_name": "IntRange", + "definition": { + "kind": "complexType", + "name": "IntRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Supported range of Recurring Time." + }, + { + "name": "RecurringDuration", + "type": "{http://www.onvif.org/ver10/schema}DurationRange", + "type_name": "DurationRange", + "definition": { + "kind": "complexType", + "name": "DurationRange", + "description": "Range of duration greater equal Min duration and less equal Max duration.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Supported range of Recurring Duration." + }, + { + "name": "Direction", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourDirection", + "type_name": "PTZPresetTourDirection", + "definition": { + "kind": "simpleType", + "name": "PTZPresetTourDirection", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Forward" + }, + { + "value": "Backward" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "Supported options for Direction of Preset Tour." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStartingConditionOptionsExtension", + "type_name": "PTZPresetTourStartingConditionOptionsExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStartingConditionOptionsExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported options for Preset Tour Starting Condition." + }, + { + "name": "TourSpot", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSpotOptions", + "type_name": "PTZPresetTourSpotOptions", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSpotOptions", + "fields": [ + { + "name": "PresetDetail", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourPresetDetailOptions", + "type_name": "PTZPresetTourPresetDetailOptions", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourPresetDetailOptions", + "fields": [ + { + "name": "PresetToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of available Preset Tokens for tour spots." + }, + { + "name": "Home", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "An option to indicate Home position for tour spots." + }, + { + "name": "PanTiltPositionSpace", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Supported range of Pan and Tilt for tour spots." + }, + { + "name": "ZoomPositionSpace", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Supported range of Zoom for a tour spot." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourPresetDetailOptionsExtension", + "type_name": "PTZPresetTourPresetDetailOptionsExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourPresetDetailOptionsExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported options for detail definition of preset position of the tour spot." + }, + { + "name": "StayTime", + "type": "{http://www.onvif.org/ver10/schema}DurationRange", + "type_name": "DurationRange", + "definition": { + "kind": "complexType", + "name": "DurationRange", + "description": "Range of duration greater equal Min duration and less equal Max duration.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported range of stay time for a tour spot." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Supported options for Preset Tour Spot." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "CreatePresetTour", + "port_type": "PTZ", + "description": "Operation to create a preset tour for the selected media profile.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}CreatePresetTourRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}CreatePresetTour", + "schema": { + "name": "CreatePresetTour", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}CreatePresetTourResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}CreatePresetTourResponse", + "schema": { + "name": "CreatePresetTourResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PresetTourToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "ModifyPresetTour", + "port_type": "PTZ", + "description": "Operation to modify a preset tour for the selected media profile.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}ModifyPresetTourRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}ModifyPresetTour", + "schema": { + "name": "ModifyPresetTour", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "PresetTour", + "type": "{http://www.onvif.org/ver10/schema}PresetTour", + "type_name": "PresetTour", + "definition": { + "kind": "complexType", + "name": "PresetTour", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Readable name of the preset tour." + }, + { + "name": "Status", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStatus", + "type_name": "PTZPresetTourStatus", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStatus", + "fields": [ + { + "name": "State", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourState", + "type_name": "PTZPresetTourState", + "definition": { + "kind": "simpleType", + "name": "PTZPresetTourState", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Idle" + }, + { + "value": "Touring" + }, + { + "value": "Paused" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Indicates state of this preset tour by Idle/Touring/Paused." + }, + { + "name": "CurrentTourSpot", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSpot", + "type_name": "PTZPresetTourSpot", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSpot", + "fields": [ + { + "name": "PresetDetail", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourPresetDetail", + "type_name": "PTZPresetTourPresetDetail", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourPresetDetail", + "fields": [ + { + "name": "PresetToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with Preset Token defined in advance." + }, + { + "name": "Home", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with the home position of this PTZ Node. \"False\" to this parameter shall be treated as an invalid argument." + }, + { + "name": "PTZPosition", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with vector of PTZ node directly." + }, + { + "name": "TypeExtension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourTypeExtension", + "type_name": "PTZPresetTourTypeExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourTypeExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Detail definition of preset position of the tour spot." + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot." + }, + { + "name": "StayTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify time duration of staying on this tour sport." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSpotExtension", + "type_name": "PTZPresetTourSpotExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSpotExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Indicates a tour spot currently staying." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStatusExtension", + "type_name": "PTZPresetTourStatusExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStatusExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Read only parameters to indicate the status of the preset tour." + }, + { + "name": "AutoStart", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Auto Start flag of the preset tour. True allows the preset tour to be activated always." + }, + { + "name": "StartingCondition", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStartingCondition", + "type_name": "PTZPresetTourStartingCondition", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStartingCondition", + "fields": [ + { + "name": "RecurringTime", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify how many times the preset tour is recurred." + }, + { + "name": "RecurringDuration", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify how long time duration the preset tour is recurred." + }, + { + "name": "Direction", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourDirection", + "type_name": "PTZPresetTourDirection", + "definition": { + "kind": "simpleType", + "name": "PTZPresetTourDirection", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Forward" + }, + { + "value": "Backward" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to choose which direction the preset tour goes. Forward shall be chosen in case it is omitted." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourStartingConditionExtension", + "type_name": "PTZPresetTourStartingConditionExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourStartingConditionExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "RandomPresetOrder", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "description": "Execute presets in random order. If set to true and Direction is also present, Direction will be ignored and presets of the Tour will be recalled randomly." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameters to specify the detail behavior of the preset tour." + }, + { + "name": "TourSpot", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSpot", + "type_name": "PTZPresetTourSpot", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSpot", + "fields": [ + { + "name": "PresetDetail", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourPresetDetail", + "type_name": "PTZPresetTourPresetDetail", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourPresetDetail", + "fields": [ + { + "name": "PresetToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with Preset Token defined in advance." + }, + { + "name": "Home", + "type": "{http://www.w3.org/2001/XMLSchema}boolean", + "type_name": "boolean", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with the home position of this PTZ Node. \"False\" to this parameter shall be treated as an invalid argument." + }, + { + "name": "PTZPosition", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Option to specify the preset position with vector of PTZ node directly." + }, + { + "name": "TypeExtension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourTypeExtension", + "type_name": "PTZPresetTourTypeExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourTypeExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Detail definition of preset position of the tour spot." + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot." + }, + { + "name": "StayTime", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional parameter to specify time duration of staying on this tour sport." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourSpotExtension", + "type_name": "PTZPresetTourSpotExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourSpotExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of detail of touring spots including preset positions." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourExtension", + "type_name": "PTZPresetTourExtension", + "definition": { + "kind": "complexType", + "name": "PTZPresetTourExtension", + "fields": [], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Unique identifier of this preset tour." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}ModifyPresetTourResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}ModifyPresetTourResponse", + "schema": { + "name": "ModifyPresetTourResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "OperatePresetTour", + "port_type": "PTZ", + "description": "Operation to perform specific operation on the preset tour in selected media profile.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}OperatePresetTourRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}OperatePresetTour", + "schema": { + "name": "OperatePresetTour", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "PresetTourToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Operation", + "type": "{http://www.onvif.org/ver10/schema}PTZPresetTourOperation", + "type_name": "PTZPresetTourOperation", + "definition": { + "kind": "simpleType", + "name": "PTZPresetTourOperation", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "Start" + }, + { + "value": "Stop" + }, + { + "value": "Pause" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}OperatePresetTourResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}OperatePresetTourResponse", + "schema": { + "name": "OperatePresetTourResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "RemovePresetTour", + "port_type": "PTZ", + "description": "Operation to delete a specific preset tour from the media profile.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}RemovePresetTourRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}RemovePresetTour", + "schema": { + "name": "RemovePresetTour", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "PresetTourToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}RemovePresetTourResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}RemovePresetTourResponse", + "schema": { + "name": "RemovePresetTourResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "GetCompatibleConfigurations", + "port_type": "PTZ", + "description": "Operation to get all available PTZConfigurations that can be added to the referenced media profile. A device providing more than one PTZConfiguration or more than one VideoSourceConfiguration or which has any other resource interdependency between PTZConfiguration entities and other resources listable in a media profile should implement this operation. PTZConfiguration entities returned by this operation shall not fail on adding them to the referenced media profile.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetCompatibleConfigurationsRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetCompatibleConfigurations", + "schema": { + "name": "GetCompatibleConfigurations", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Contains the token of an existing media profile the configurations shall be compatible with." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}GetCompatibleConfigurationsResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}GetCompatibleConfigurationsResponse", + "schema": { + "name": "GetCompatibleConfigurationsResponse", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "PTZConfiguration", + "type": "{http://www.onvif.org/ver10/schema}PTZConfiguration", + "type_name": "PTZConfiguration", + "definition": { + "kind": "complexType", + "name": "PTZConfiguration", + "base": "{http://www.onvif.org/ver10/schema}ConfigurationEntity", + "base_definition": { + "kind": "complexType", + "name": "ConfigurationEntity", + "description": "Base type defining the common properties of a configuration.", + "fields": [ + { + "name": "Name", + "type": "{http://www.onvif.org/ver10/schema}Name", + "type_name": "Name", + "definition": { + "kind": "simpleType", + "name": "Name", + "description": "User readable name. Length up to 64 characters.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "User readable name. Length up to 64 characters." + }, + { + "name": "UseCount", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "type_name": "int", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Number of internal references currently using this configuration.

This informational parameter is read-only. Deprecated for Media2 Service.

" + } + ], + "attributes": [ + { + "use": "required", + "name": "token", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "description": "Token that uniquely references this configuration. Length up to 64 characters." + } + ] + }, + "fields": [ + { + "name": "NodeToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A mandatory reference to the PTZ Node that the PTZ Configuration belongs to." + }, + { + "name": "DefaultAbsolutePantTiltPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default." + }, + { + "name": "DefaultAbsoluteZoomPositionSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default." + }, + { + "name": "DefaultRelativePanTiltTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default." + }, + { + "name": "DefaultRelativeZoomTranslationSpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default." + }, + { + "name": "DefaultContinuousPanTiltVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default." + }, + { + "name": "DefaultContinuousZoomVelocitySpace", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default." + }, + { + "name": "DefaultPTZSpeed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds." + }, + { + "name": "DefaultPTZTimeout", + "type": "{http://www.w3.org/2001/XMLSchema}duration", + "type_name": "duration", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops." + }, + { + "name": "PanTiltLimits", + "type": "{http://www.onvif.org/ver10/schema}PanTiltLimits", + "type_name": "PanTiltLimits", + "definition": { + "kind": "complexType", + "name": "PanTiltLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space2DDescription", + "type_name": "Space2DDescription", + "definition": { + "kind": "complexType", + "name": "Space2DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + }, + { + "name": "YRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of y-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of pan tilt limits." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Pan/Tilt limits element should be present for a PTZ Node that supports an absolute Pan/Tilt. If the element is present it signals the support for configurable Pan/Tilt limits. If limits are enabled, the Pan/Tilt movements shall always stay within the specified range. The Pan/Tilt limits are disabled by setting the limits to -INF or +INF." + }, + { + "name": "ZoomLimits", + "type": "{http://www.onvif.org/ver10/schema}ZoomLimits", + "type_name": "ZoomLimits", + "definition": { + "kind": "complexType", + "name": "ZoomLimits", + "fields": [ + { + "name": "Range", + "type": "{http://www.onvif.org/ver10/schema}Space1DDescription", + "type_name": "Space1DDescription", + "definition": { + "kind": "complexType", + "name": "Space1DDescription", + "fields": [ + { + "name": "URI", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "type_name": "anyURI", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A URI of coordinate systems." + }, + { + "name": "XRange", + "type": "{http://www.onvif.org/ver10/schema}FloatRange", + "type_name": "FloatRange", + "definition": { + "kind": "complexType", + "name": "FloatRange", + "description": "Range of values greater equal Min value and less equal Max value.", + "fields": [ + { + "name": "Min", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + }, + { + "name": "Max", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "type_name": "float", + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of x-axis." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A range of zoom limit" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The Zoom limits element should be present for a PTZ Node that supports absolute zoom. If the element is present it signals the supports for configurable Zoom limits. If limits are enabled the zoom movements shall always stay within the specified range. The Zoom limits are disabled by settings the limits to -INF and +INF." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension", + "type_name": "PTZConfigurationExtension", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension", + "fields": [ + { + "name": "PTControlDirection", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirection", + "type_name": "PTControlDirection", + "definition": { + "kind": "complexType", + "name": "PTControlDirection", + "fields": [ + { + "name": "EFlip", + "type": "{http://www.onvif.org/ver10/schema}EFlip", + "type_name": "EFlip", + "definition": { + "kind": "complexType", + "name": "EFlip", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}EFlipMode", + "type_name": "EFlipMode", + "definition": { + "kind": "simpleType", + "name": "EFlipMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable E-Flip feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for E-Flip." + }, + { + "name": "Reverse", + "type": "{http://www.onvif.org/ver10/schema}Reverse", + "type_name": "Reverse", + "definition": { + "kind": "complexType", + "name": "Reverse", + "fields": [ + { + "name": "Mode", + "type": "{http://www.onvif.org/ver10/schema}ReverseMode", + "type_name": "ReverseMode", + "definition": { + "kind": "simpleType", + "name": "ReverseMode", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "enumeration": [ + { + "value": "OFF" + }, + { + "value": "ON" + }, + { + "value": "AUTO" + }, + { + "value": "Extended" + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "Parameter to enable/disable Reverse feature." + } + ], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure related parameters for reversing of PT Control Direction." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTControlDirectionExtension", + "type_name": "PTControlDirectionExtension", + "definition": { + "kind": "complexType", + "name": "PTControlDirectionExtension", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Optional element to configure PT Control Direction related features." + }, + { + "name": "Extension", + "type": "{http://www.onvif.org/ver10/schema}PTZConfigurationExtension2", + "type_name": "PTZConfigurationExtension2", + "definition": { + "kind": "complexType", + "name": "PTZConfigurationExtension2", + "fields": [], + "any": { + "namespace": "##targetNamespace", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "any": { + "namespace": "##other", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false + } + ], + "attributes": [ + { + "use": "optional", + "name": "MoveRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when moving." + }, + { + "use": "optional", + "name": "PresetRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when recalling presets." + }, + { + "use": "optional", + "name": "PresetTourRamp", + "type": "{http://www.w3.org/2001/XMLSchema}int", + "description": "The optional acceleration ramp used by the device when executing PresetTours." + } + ], + "any_attribute": { + "namespace": "##any", + "process_contents": "lax" + } + }, + "min_occurs": 0, + "max_occurs": "unbounded", + "nillable": false, + "description": "A list of all existing PTZConfigurations on the NVT that is suitable to be added to the addressed media profile." + } + ] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + }, + { + "name": "MoveAndStartTracking", + "port_type": "PTZ", + "description": "Operation to send an an atomic command to the device: move the camera to a wanted position and then delegate the PTZ control to the tracking algorithm. An existing Speed argument overrides DefaultSpeed of the corresponding PTZ configuration during movement to the requested position. If spaces are referenced within the Speed argument, they shall be speed spaces supported by the PTZ node. If the detection and the tracking are done in the same device, an ObjectID reference can be passed as an argument, in order to specify which object should be tracked. The operation shall fail if the requested absolute position is not reachable.", + "input": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}MoveAndStartTrackingRequest", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}MoveAndStartTracking", + "schema": { + "name": "MoveAndStartTracking", + "definition": { + "kind": "complexType", + "fields": [ + { + "name": "ProfileToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false, + "description": "A reference to the MediaProfile where the operation should take place." + }, + { + "name": "PresetToken", + "type": "{http://www.onvif.org/ver10/schema}ReferenceToken", + "type_name": "ReferenceToken", + "definition": { + "kind": "simpleType", + "name": "ReferenceToken", + "description": "Unique identifier for a physical or logical resource.\n\t\t\tTokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.\n\t\t\tLength up to 64 characters. Token may be extended by intermediate terminal with adding prefix to make it global unique.\n\t\t\tThe length should be within 36 characters for generating at local device. See \"Remote Token\" section in Resource Query specification.", + "base": "{http://www.w3.org/2001/XMLSchema}string", + "maxLength": "64" + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A preset token." + }, + { + "name": "GeoLocation", + "type": "{http://www.onvif.org/ver10/schema}GeoLocation", + "type_name": "GeoLocation", + "definition": { + "kind": "complexType", + "name": "GeoLocation", + "fields": [], + "attributes": [ + { + "use": "optional", + "name": "lon", + "type": "{http://www.w3.org/2001/XMLSchema}double", + "description": "East west location as angle." + }, + { + "use": "optional", + "name": "lat", + "type": "{http://www.w3.org/2001/XMLSchema}double", + "description": "North south location as angle." + }, + { + "use": "optional", + "name": "elevation", + "type": "{http://www.w3.org/2001/XMLSchema}float", + "description": "Height in meters above sea level." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + }, + "any_attribute": { + "namespace": "##any", + "process_contents": "strict" + } + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "The geolocation of the target position." + }, + { + "name": "TargetPosition", + "type": "{http://www.onvif.org/ver10/schema}PTZVector", + "type_name": "PTZVector", + "definition": { + "kind": "complexType", + "name": "PTZVector", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt position. The x component corresponds to pan and the y component to tilt." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom position." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A Position vector specifying the absolute target position." + }, + { + "name": "Speed", + "type": "{http://www.onvif.org/ver10/schema}PTZSpeed", + "type_name": "PTZSpeed", + "definition": { + "kind": "complexType", + "name": "PTZSpeed", + "fields": [ + { + "name": "PanTilt", + "type": "{http://www.onvif.org/ver10/schema}Vector2D", + "type_name": "Vector2D", + "definition": { + "kind": "complexType", + "name": "Vector2D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "required", + "name": "y", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Pan/tilt coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected." + }, + { + "name": "Zoom", + "type": "{http://www.onvif.org/ver10/schema}Vector1D", + "type_name": "Vector1D", + "definition": { + "kind": "complexType", + "name": "Vector1D", + "fields": [], + "attributes": [ + { + "use": "required", + "name": "x", + "type": "{http://www.w3.org/2001/XMLSchema}float" + }, + { + "use": "optional", + "name": "space", + "type": "{http://www.w3.org/2001/XMLSchema}anyURI", + "description": "Zoom coordinate space selector. The following options are defined:
    \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
    • \n\t\t\t\t\t\t
  • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • \n\t\t\t\t\t
" + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected." + } + ] + }, + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Speed vector specifying the velocity of pan, tilt and zoom." + }, + { + "name": "ObjectID", + "type": "{http://www.w3.org/2001/XMLSchema}integer", + "type_name": "integer", + "min_occurs": 0, + "max_occurs": 1, + "nillable": false, + "description": "Object ID of the object to track." + } + ], + "any": { + "namespace": "##any", + "process_contents": "lax", + "min_occurs": 0, + "max_occurs": "unbounded" + } + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "output": { + "message": "{http://www.onvif.org/ver20/ptz/wsdl}MoveAndStartTrackingResponse", + "parts": [ + { + "name": "parameters", + "element": "{http://www.onvif.org/ver20/ptz/wsdl}MoveAndStartTrackingResponse", + "schema": { + "name": "MoveAndStartTrackingResponse", + "definition": { + "kind": "complexType", + "fields": [] + }, + "min_occurs": 1, + "max_occurs": 1, + "nillable": false + } + } + ] + }, + "faults": [], + "binding": "PTZBinding" + } + ] +} diff --git a/docs/hooks/griffe_extensions.py b/docs/hooks/griffe_extensions.py index bc411648..b41d1eea 100644 --- a/docs/hooks/griffe_extensions.py +++ b/docs/hooks/griffe_extensions.py @@ -3,9 +3,12 @@ from __future__ import annotations import importlib.util +import re from pathlib import Path +from typing import Any import griffe +from griffe import Extension, Function, Object _SHORTCODES_PATH = Path(__file__).with_name("shortcodes.py") _SPEC = importlib.util.spec_from_file_location( @@ -21,6 +24,14 @@ replace_docstring_shortcodes = _SHORTCODES.replace_docstring_shortcodes +# Join words split across lines after a hyphen. +_HYPHENATED_LINE_BREAK = re.compile(r"(?<=[A-Za-z])-\s*\n\s*(?=[A-Za-z])") + + +def normalize_docstring_line_breaks(text: str) -> str: + """Normalize words split across lines in docstrings.""" + return _HYPHENATED_LINE_BREAK.sub("-", text) + class DocstringShortcodes(griffe.Extension): """Process supported Markdown shortcodes in Python docstrings.""" @@ -32,4 +43,59 @@ def on_object(self, *, obj: griffe.Object, **kwargs) -> None: if docstring is None: return + docstring.value = normalize_docstring_line_breaks(docstring.value) docstring.value = replace_docstring_shortcodes(docstring.value) + + docstring.value = replace_docstring_shortcodes(docstring.value) + + +# Match ONVIF-style method names, such as GetServices and GetServiceCapabilities. +_METHOD_REFERENCE = re.compile( + r"(?(?:Get|Set|Create|Delete|Add|Remove|Start|Stop|" + r"Renew|Unsubscribe|Subscribe|Pause|Resume|Send|Find|Load|" + r"Save|Activate|Reboot|Restore|Upgrade|SystemReboot)" + r"[A-Z][A-Za-z0-9_]*)" + r"(?![\w`.\]])" +) + + +class DocstringCrossReferences(Extension): + """Automatically link API method references in docstrings.""" + + def on_object(self, *, obj: Object, **kwargs: Any) -> None: + """Link references to methods in the same parent class.""" + if not isinstance(obj, Function): + return + + docstring = obj.docstring + if docstring is None or obj.parent is None: + return + + docstring.value = self._link_methods(docstring.value, obj) + + @staticmethod + def _link_methods(text: str, obj: Function) -> str: + """Resolve method references against the parent class.""" + parent = obj.parent + if parent is None: + return text + + members = getattr(parent, "members", {}) + method_names = { + name for name, member in members.items() if isinstance(member, Function) + } + + if not method_names: + return text + + def replace(match: re.Match[str]) -> str: + name = match.group("name") + + if name not in method_names: + return name + + target = members[name] + return f"[`{name}`][{target.path}]" + + return _METHOD_REFERENCE.sub(replace, text) diff --git a/docs/hooks/wsdl_schema.py b/docs/hooks/wsdl_schema.py new file mode 100644 index 00000000..43edc363 --- /dev/null +++ b/docs/hooks/wsdl_schema.py @@ -0,0 +1,232 @@ +"""Attach generated WSDL schemas to API operations.""" + +import json +from pathlib import Path +from typing import Any + +from griffe import Extension, Function + +from onvif.mappings import ONVIF_NAMESPACE_MAP + +# Keys are normalized Python API service identifiers. +# Values are paths relative to metadata_dir. +PREFERRED_SOURCES: dict[str, str] = { + "display": "ver10/display.json", + "events": "ver10/events/wsdl/event-vs.json", + "pullpoint": "ver10/events/wsdl/event-vs.json", + "notification": "ver10/events/wsdl/bw-2-vs-mod.json", + "subscription": "ver10/events/wsdl/bw-2-vs-mod.json", + "pausable_subscription": "ver10/events/wsdl/bw-2-vs-mod.json", +} + + +class WSDLSchemaExtension(Extension): + """Load WSDL metadata and attach schemas to matching API operations.""" + + def __init__( + self, + metadata_dir: str = "docs/generated/wsdl", + ) -> None: + super().__init__() + self.metadata_dir = Path(metadata_dir) + self.schemas: list[dict[str, Any]] = [] + self._load_metadata() + + @staticmethod + def _normalize(value: str) -> str: + """Normalize an identifier for case-insensitive comparison.""" + return "".join(char for char in value.lower() if char.isalnum()) + + @classmethod + def _path_components(cls, value: str) -> set[str]: + """Extract normalized identifiers from a dotted Python path.""" + return { + normalized + for component in value.split(".") + if (normalized := cls._normalize(component)) + } + + @classmethod + def _namespace_services( + cls, + namespace: str, + ) -> tuple[tuple[str, str], ...]: + """Return service identifiers and bindings for a WSDL namespace.""" + normalized_namespace = namespace.rstrip("/").lower() + + for mapped_namespace, services in ONVIF_NAMESPACE_MAP.items(): + if mapped_namespace.rstrip("/").lower() == normalized_namespace: + return services + + return () + + def _load_metadata(self) -> None: + """Load operation metadata while preserving WSDL context.""" + if not self.metadata_dir.is_dir(): + return + + for path in sorted(self.metadata_dir.rglob("*.json")): + try: + data = json.loads(path.read_text(encoding="utf-8")) + except (OSError, json.JSONDecodeError): + continue + + if not isinstance(data, dict): + continue + + namespace = data.get("target_namespace") + operations = data.get("operations") + + if not isinstance(namespace, str) or not isinstance(operations, list): + continue + + binding = data.get("binding") + + for operation in operations: + if not isinstance(operation, dict): + continue + + name = operation.get("name") + if not isinstance(name, str) or not name: + continue + + self.schemas.append( + { + "target_namespace": namespace, + "source": path, + "binding": binding, + "operation": operation, + } + ) + + @classmethod + def _mapped_service( + cls, + record: dict[str, Any], + ) -> str | None: + """Resolve the Python service identifier from namespace and binding.""" + namespace = record["target_namespace"] + operation = record["operation"] + services = cls._namespace_services(namespace) + + if not services: + services = tuple( + (service, mapped_binding) + for mapped_services in ONVIF_NAMESPACE_MAP.values() + for service, mapped_binding in mapped_services + ) + + binding = operation.get("binding") or record.get("binding") + bindings = operation.get("bindings", []) + + if binding: + bindings = [binding] + elif not bindings: + bindings = [ + operation.get("binding_name"), + record.get("service_binding"), + ] + bindings = [item for item in bindings if item] + + if not bindings: + return None + + normalized_bindings = { + cls._normalize(item) for item in bindings if isinstance(item, str) and item + } + + matches = { + cls._normalize(service) + for service, mapped_binding in services + if cls._normalize(mapped_binding) in normalized_bindings + } + + if len(matches) != 1: + return None + + return matches.pop() + + def _preferred_source( + self, + service: str, + ) -> str | None: + """Return the preferred metadata source for a Python API service.""" + normalized_service = self._normalize(service) + + for identifier, source in PREFERRED_SOURCES.items(): + if self._normalize(identifier) == normalized_service: + return source + + return None + + def _select_candidate( + self, + candidates: list[dict[str, Any]], + service: str, + func_path: str, + ) -> dict[str, Any] | None: + """Select a unique candidate, preferring its configured source.""" + if len(candidates) == 1: + return candidates[0] + + preferred_source = self._preferred_source(service) + + if preferred_source is None: + print( + f"[WSDL] Ambiguous match: {func_path} " + f"({len(candidates)} candidates)" + ) + return None + + preferred_path = (self.metadata_dir / preferred_source).resolve() + preferred_candidates = [ + record + for record in candidates + if record["source"].resolve() == preferred_path + ] + + if len(preferred_candidates) == 1: + return preferred_candidates[0] + + print( + f"[WSDL] Ambiguous match: {func_path} " + f"({len(candidates)} candidates; " + f"preferred source={preferred_source!r}, " + f"matches={len(preferred_candidates)})" + ) + return None + + def on_function(self, *, func: Function, **kwargs: Any) -> None: + """Attach schema metadata when exactly one operation matches.""" + function_components = self._path_components(func.path) + + candidates = [ + record + for record in self.schemas + if record["operation"].get("name") == func.name + and (service := self._mapped_service(record)) is not None + and service in function_components + ] + + if not candidates: + return + + # The matching Python service is derived from the candidate records. + services = { + service + for record in candidates + if (service := self._mapped_service(record)) is not None + } + + if len(services) != 1: + print( + f"[WSDL] Ambiguous service: {func.path} " + f"({', '.join(sorted(services))})" + ) + return + + service = services.pop() + selected = self._select_candidate(candidates, service, func.path) + + if selected is not None: + func.extra["wsdl_schema"] = selected["operation"] diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 33b3c22c..40c99018 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -820,4 +820,225 @@ html { .md-typeset [type="checkbox"]:checked + .task-list-indicator::before { background-color: var(--color-success); mask-image: var(--md-tasklist-icon--checked); +} + +/* WSDL schema — consistent typography */ +.wsdl-schema__content { + padding-top: 0.5rem; + font-size: 0.7rem; + line-height: 1.6; +} + +.wsdl-schema__heading { + font-size: inherit; + line-height: 1.6; +} + +.wsdl-schema__return { + margin-left: 0.35rem; + font-weight: 400; +} + +.wsdl-schema__name, +.wsdl-schema__heading code { + font-size: inherit; +} + +.wsdl-schema__description, +.wsdl-schema__meta, +.wsdl-schema__enum { + font-size: inherit; + line-height: inherit; +} + +/* Nested fields should retain the parent's font size */ +.wsdl-schema__tree, +.wsdl-schema__item, +.wsdl-schema__node { + font-size: inherit; +} + +/* WSDL schema tree — reset list markers */ +.wsdl-schema__content .wsdl-schema__tree, +.wsdl-schema__content .wsdl-schema__tree ul { + list-style: none !important; + list-style-type: none !important; + margin-top: 0rem; + margin-bottom: 0; + padding-left: 0; +} + +/* Remove Material/list pseudo-markers */ +.wsdl-schema__content .wsdl-schema__tree > .wsdl-schema__item::marker { + content: ""; +} + +.wsdl-schema__content .wsdl-schema__tree > .wsdl-schema__item::before { + content: none !important; + display: none !important; +} + +/* Top-level parameters: no connectors */ +.wsdl-schema__content > .wsdl-schema__tree { + border: 0; + margin-left: 0; + padding-left: 0; +} + +/* Nested levels */ +.wsdl-schema__content .wsdl-schema__tree .wsdl-schema__tree { + position: relative; + margin-left: 0.5rem; + padding-left: 0.75rem; + border-left: 2px solid var(--md-default-fg-color--lightest); +} + +/* Tree nodes */ +.wsdl-schema__content .wsdl-schema__item { + position: relative; + margin: 0; + padding: 0.3rem 0; + border: 0; +} + +.wsdl-schema__content .wsdl-schema__node { + position: relative; + min-width: 0; +} + +/* Horizontal connectors */ +.wsdl-schema__content + .wsdl-schema__tree + .wsdl-schema__tree + > .wsdl-schema__item + > .wsdl-schema__node::before { + content: ""; + position: absolute; + left: -0.75rem; + top: 0.8em; + width: 0.5rem; + border-top: 2px solid var(--md-default-fg-color--lightest); +} + +/* Reset list item margins */ +.md-typeset .wsdl-schema__content .wsdl-schema__tree > .wsdl-schema__item { + margin-left: 0; +} + +/* Consistent typography at every nesting level */ +.wsdl-schema__content .wsdl-schema__node, +.wsdl-schema__content .wsdl-schema__heading, +.wsdl-schema__content .wsdl-schema__description, +.wsdl-schema__content .wsdl-schema__meta, +.wsdl-schema__content .wsdl-schema__enum { + font-size: inherit; +} + +.wsdl-schema__heading { + display: flex; + flex-wrap: wrap; + align-items: baseline; + gap: 0.25rem; + line-height: 1.6; +} + +.wsdl-schema__name { + font-weight: 600; + overflow-wrap: anywhere; +} + +.wsdl-schema__description { + margin-top: 0.1rem; + line-height: 1.6; +} + +.wsdl-schema__meta, +.wsdl-schema__enum { + margin-top: 0.15rem; + line-height: 1.6; + overflow-wrap: anywhere; +} + +/* Input/Output admonition */ +:root { + --md-admonition-icon--wsdl-input: url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 -960 960 960'%3E%3Cpath d='M480-320 280-520l56-58 104 104v-326h80v326l104-104 56 58-200 200ZM240-160q-33 0-56.5-23.5T160-240v-120h80v120h480v-120h80v120q0 33-23.5 56.5T720-160H240Z'/%3E%3C/svg%3E"); + + --md-admonition-icon--wsdl-output: url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 -960 960 960'%3E%3Cpath d='M440-320v-326L336-542l-56-58 200-200 200 200-56 58-104-104v326h-80ZM240-160q-33 0-56.5-23.5T160-240v-120h80v120h480v-120h80v120q0 33-23.5 56.5T720-160H240Z'/%3E%3C/svg%3E"); +} + +/* WSDL schema — theme-specific backgrounds */ +[data-md-color-scheme="default"] { + --wsdl-input-bg: #5bad0f08; + --wsdl-output-bg: #8250df08; +} + +[data-md-color-scheme="slate"] { + --wsdl-input-bg: #baff791a; + --wsdl-output-bg: #d2a8ff1a; +} + +/* WSDL Input */ +.md-typeset .admonition.wsdl-input, +.md-typeset details.wsdl-input { + border-color: var(--doc-symbol-module-fg-color); + background-color: var(--wsdl-input-bg); +} + +.md-typeset .wsdl-input > .admonition-title, +.md-typeset .wsdl-input > summary { + color: var(--doc-symbol-module-fg-color); + background-color: var(--wsdl-input-bg); +} + +.md-typeset .wsdl-input > .admonition-title::before, +.md-typeset .wsdl-input > summary::before { + background-color: var(--doc-symbol-module-fg-color); + -webkit-mask-image: var(--md-admonition-icon--wsdl-input); + mask-image: var(--md-admonition-icon--wsdl-input); +} + +/* WSDL Output */ +.md-typeset .admonition.wsdl-output, +.md-typeset details.wsdl-output { + border-color: var(--doc-symbol-method-fg-color); + background-color: var(--wsdl-output-bg); +} + +.md-typeset .wsdl-output > .admonition-title, +.md-typeset .wsdl-output > summary { + color: var(--doc-symbol-method-fg-color); + background-color: var(--wsdl-output-bg); +} + +.md-typeset .wsdl-output > .admonition-title::before, +.md-typeset .wsdl-output > summary::before { + background-color: var(--doc-symbol-method-fg-color); + -webkit-mask-image: var(--md-admonition-icon--wsdl-output); + mask-image: var(--md-admonition-icon--wsdl-output); +} + +/* Enum table */ +.wsdl-schema__enum table { + display: table; + width: 100%; + margin: 0; + font-size: 0.85rem; +} + +.wsdl-schema__enum th, +.wsdl-schema__enum td { + vertical-align: top; +} + +.wsdl-schema__enum th { + white-space: nowrap; +} + +.wsdl-schema__enum td:first-child { + width: 1%; + white-space: nowrap; +} + +.wsdl-schema__enum .md-typeset__table { + margin: 0; } \ No newline at end of file diff --git a/docs/templates/python/material/function.html.jinja b/docs/templates/python/material/function.html.jinja new file mode 100644 index 00000000..98472c1f --- /dev/null +++ b/docs/templates/python/material/function.html.jinja @@ -0,0 +1,230 @@ + +{% extends "_base/function.html.jinja" %} + +{% macro has_schema_fields(definition) %} + {% set fields = definition.get("fields", []) or [] %} + {% set attributes = definition.get("attributes", []) or [] %} + {% set base_definition = definition.get("base_definition", {}) or {} %} + {% set inherited_fields = base_definition.get("fields", []) or [] %} + {{ "true" if fields or attributes or inherited_fields else "false" }} +{% endmacro %} + + +{% macro render_schema(node, depth=0) %} + {% set fields = node.get("fields", []) or [] %} + {% set base_definition = node.get("base_definition", {}) or {} %} + {% set inherited_fields = base_definition.get("fields", []) or [] %} + + {% if fields or inherited_fields %} +
    + {% for field in inherited_fields %} + {{ render_schema_row(field, depth) }} + {% endfor %} + {% for field in fields %} + {{ render_schema_row(field, depth) }} + {% endfor %} +
+ {% endif %} +{% endmacro %} + + +{% macro render_schema_row(field, depth=0) %} + {% set definition = field.get("definition", {}) or {} %} + {% set field_name = field.get("name") or field.get("ref") or "—" %} + {% set type_name = field.get("type_name") or field.get("type") or definition.get("kind") %} + {% set nested_fields = definition.get("fields", []) or [] %} + {% set base_definition = definition.get("base_definition", {}) or {} %} + {% set inherited_fields = base_definition.get("fields", []) or [] %} + {% set enumeration = definition.get("enumeration", []) or [] %} + {% set minimum = field.get("min_occurs", 1) %} + {% set maximum = field.get("max_occurs", 1) %} + {% set use = field.get("use") %} + +
  • +
    +
    + {{ field_name | e }} + + {% if use == "required" %} + - required; + {% elif minimum == 0 and maximum == "unbounded" %} + - optional, unbounded; + {% elif maximum == "unbounded" %} + - unbounded; + {% elif minimum == 0 %} + - optional; + {% endif %} + + {% if type_name %} + {% set clean_type = type_name|string %} + + [{{ clean_type.split("}")[-1] | e }}] + + {% endif %} +
    + + {% if field.get("description") %} +
    + {{ field.get("description") | safe }} +
    + {% endif %} + + {% if field.get("default") is not none %} +
    + Default: {{ field.get("default") | e }} +
    + {% endif %} + + {% if field.get("fixed") is not none %} +
    + Fixed: {{ field.get("fixed") | e }} +
    + {% endif %} + + {% if enumeration %} +
    + + + + + + + + + {% for item in enumeration %} + {% if item is mapping %} + {% set enum_value = item.get("value", "") %} + {% set enum_description = item.get("description", "—") %} + {% else %} + {% set enum_value = item %} + {% set enum_description = "—" %} + {% endif %} + + + + + {% endfor %} + +
    Enum ValueEnum Description
    {{ enum_value | e }}{{ enum_description | safe }}
    +
    + {% endif %} + + {% for key, label in [ + ("minLength", "Minimum length"), + ("maxLength", "Maximum length"), + ("length", "Exact length"), + ("pattern", "Pattern"), + ("minInclusive", "Minimum value"), + ("maxInclusive", "Maximum value"), + ("minExclusive", "Exclusive minimum"), + ("maxExclusive", "Exclusive maximum"), + ("totalDigits", "Total digits"), + ("fractionDigits", "Fraction digits"), + ("whiteSpace", "Whitespace") + ] %} + {% if definition.get(key) is not none %} +
    + {{ label }}: {{ definition.get(key) | e }} +
    + {% endif %} + {% endfor %} + + {% if definition.get("attributes") %} +
      + {% for attribute in definition.get("attributes", []) %} + {% set attribute_type = attribute.get("type") %} +
    • +
      +
      + + {{ attribute.get("name") or attribute.get("ref") or "—" | e }} + + + {% if attribute.get("use") == "required" %} + - required; + {% elif attribute.get("use") == "optional" %} + - optional; + {% endif %} + + {% if attribute_type %} + {% set clean_attribute_type = attribute_type|string %} + + [{{ clean_attribute_type.split("}")[-1] | e }}] + + {% endif %} +
      + + {% if attribute.get("description") %} +
      + {{ attribute.get("description") | safe }} +
      + {% endif %} +
      +
      • + {% endfor %} +
    + {% endif %} + + {% if nested_fields or inherited_fields %} + {{ render_schema(definition, depth + 1) }} + {% endif %} +
    +
    • +{% endmacro %} + + +{% block contents scoped %} + {{ super() }} + + {% set operation_schema = obj.extra.get("wsdl_schema") %} + + {% if operation_schema %} + {% for section in ("input", "output") %} + {% set message = operation_schema.get(section, {}) or {} %} + {% set parts = message.get("parts", []) or [] %} + {% set visible_parts = [] %} + + {% for part in parts %} + {% set schema = part.get("schema", {}) or {} %} + {% set definition = schema.get("definition", {}) or {} %} + {% set has_fields = has_schema_fields(definition) | trim %} + + {% if has_fields == "true" %} + {% set _ = visible_parts.append(part) %} + {% endif %} + {% endfor %} + + {% if visible_parts %} +
    + + {{ section | title }} + + +
    + {% for part in visible_parts %} + {% set part_schema = part.get("schema", {}) or {} %} + {% set part_definition = part_schema.get("definition", {}) or {} %} + {% set response_name = ( + part_schema.get("name") + or part.get("name") + or part_schema.get("element") + or part_schema.get("type") + ) %} + + {% if part_schema.get("description") %} +

    {{ part_schema.get("description") | safe }}

    + {% endif %} + + {% if has_schema_fields(part_definition) | trim == "true" %} + {{ render_schema(part_definition) }} + {% elif response_name %} + {% set clean_response_name = response_name | string | replace("}", " ") %} + {{ clean_response_name.split(" ")[-1] | e }} + {% endif %} + {% endfor %} +
    +
    + {% endif %} + {% endfor %} + {% endif %} +{% endblock contents %} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 66f1b418..3b54c798 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -191,6 +191,7 @@ plugins: show_email_address: false sort_authors_by: contribution - mkdocstrings: + custom_templates: docs/templates handlers: python: inventories: @@ -211,6 +212,9 @@ plugins: show_symbol_type_heading: true extensions: - docs/hooks/griffe_extensions.py:DocstringShortcodes + - docs/hooks/griffe_extensions.py:DocstringCrossReferences + - docs/hooks/wsdl_schema.py:WSDLSchemaExtension: + metadata_dir: docs/generated/wsdl markdown_extensions: - abbr diff --git a/scripts/generate_wsdl_metadata.py b/scripts/generate_wsdl_metadata.py new file mode 100644 index 00000000..eaa12660 --- /dev/null +++ b/scripts/generate_wsdl_metadata.py @@ -0,0 +1,673 @@ +"""Generate JSON metadata from local ONVIF WSDL and XSD files.""" + +from __future__ import annotations + +import html +import json +from html import escape +from pathlib import Path +from typing import Any + +from lxml import etree + +ROOT = Path(__file__).resolve().parents[1] +WSDL_DIR = ROOT / "onvif" / "wsdl" +OUTPUT_DIR = ROOT / "docs" / "generated" / "wsdl" + +WSDL_NS = "http://schemas.xmlsoap.org/wsdl/" +XSD_NS = "http://www.w3.org/2001/XMLSchema" +SOAP_NS = "http://schemas.xmlsoap.org/wsdl/soap/" + +NS = {"wsdl": WSDL_NS, "xsd": XSD_NS, "soap": SOAP_NS} + +PARSER = etree.XMLParser( + resolve_entities=False, + no_network=True, + load_dtd=False, + huge_tree=False, + remove_comments=True, +) + + +def qname(value: str | None, node: etree._Element) -> str | None: + """Resolve a lexical QName to Clark notation.""" + if not value: + return None + + try: + return _resolve_qname(value, node) + except (ValueError, KeyError): + return value + + +def _resolve_qname(value: str, node: etree._Element) -> str: + """Resolve a QName using the namespace declarations in scope.""" + if value.startswith("{"): + return value + + if ":" in value: + prefix, local = value.split(":", 1) + namespace = node.nsmap.get(prefix) + if namespace is None: + raise ValueError(f"Undeclared QName prefix: {prefix}") + return f"{{{namespace}}}{local}" + + # An unprefixed QName uses the default namespace when declared. + namespace = node.nsmap.get(None) + return f"{{{namespace}}}{value}" if namespace else value + + +def local_name(value: str | None) -> str | None: + """Return the local part of a QName.""" + if not value: + return None + return etree.QName(value).localname if value.startswith("{") else value + + +def parse_xml(path: Path) -> etree._ElementTree: + """Parse an XML document without network access or entity expansion.""" + return etree.parse(str(path), PARSER) + + +class WSDLMetadataGenerator: + """Collect WSDL operations and resolve their XML schema structures.""" + + def __init__(self, wsdl_dir: Path) -> None: + self.wsdl_dir = wsdl_dir + self.documents: dict[Path, etree._ElementTree] = {} + self.elements: dict[str, etree._Element] = {} + self.types: dict[str, etree._Element] = {} + self.messages: dict[str, etree._Element] = {} + self.port_types: dict[str, etree._Element] = {} + self.bindings: dict[str, etree._Element] = {} + self._load_documents() + + def _load_documents(self) -> None: + """Load WSDL/XSD documents and index global declarations.""" + paths = sorted( + path + for path in self.wsdl_dir.rglob("*") + if path.suffix.lower() in {".wsdl", ".xsd"} + ) + + for path in paths: + tree = parse_xml(path) + self.documents[path] = tree + root = tree.getroot() + target_ns = root.get("targetNamespace", "") + + if etree.QName(root).localname == "schema": + self._index_schema(root, target_ns) + continue + + for message in root.findall("wsdl:message", NS): + name = message.get("name") + if name: + self.messages[f"{{{target_ns}}}{name}"] = message + + for port_type in root.findall("wsdl:portType", NS): + name = port_type.get("name") + if name: + self.port_types[f"{{{target_ns}}}{name}"] = port_type + + for binding in root.findall("wsdl:binding", NS): + name = binding.get("name") + if name: + self.bindings[f"{{{target_ns}}}{name}"] = binding + + # Inline schemas inside wsdl:types. + for schema in root.findall("wsdl:types/xsd:schema", NS): + self._index_schema(schema, schema.get("targetNamespace", target_ns)) + + def _index_schema(self, schema: etree._Element, target_ns: str) -> None: + """Index global XSD elements and type declarations.""" + for element in schema.findall("xsd:element", NS): + name = element.get("name") + if name: + self.elements[f"{{{target_ns}}}{name}"] = element + + for kind in ("complexType", "simpleType"): + for node in schema.findall(f"xsd:{kind}", NS): + name = node.get("name") + if name: + self.types[f"{{{target_ns}}}{name}"] = node + + @staticmethod + def _documentation(node: etree._Element) -> str | None: + """Extract documentation and preserve safe embedded HTML markup.""" + annotation = node.find("xsd:annotation/xsd:documentation", NS) + if annotation is None: + return None + + allowed_tags = { + "a", + "b", + "strong", + "i", + "em", + "code", + "p", + "br", + "ul", + "ol", + "li", + "sub", + "sup", + } + allowed_attributes = {"href", "title"} + void_tags = {"br"} + + def render(element: etree._Element) -> str: + """Render an XML documentation node as namespace-free HTML.""" + parts: list[str] = [] + tag = etree.QName(element).localname + + if tag in allowed_tags: + attrs: list[str] = [] + + for key, value in element.attrib.items(): + attr_name = etree.QName(key).localname + + if attr_name not in allowed_attributes: + continue + + if attr_name == "href" and not value.strip().lower().startswith( + ("https://", "http://", "mailto:", "#", "/") + ): + continue + + attrs.append(f' {attr_name}="{escape(value, quote=True)}"') + + parts.append(f"<{tag}{''.join(attrs)}>") + + parts.append(escape(html.unescape(element.text or ""), quote=False)) + + for child in element: + parts.append(render(child)) + parts.append(escape(html.unescape(child.tail or ""), quote=False)) + + if tag in allowed_tags and tag not in void_tags: + parts.append(f"") + + return "".join(parts) + + description = render(annotation).strip() + return description or None + + # pylint: disable=too-many-branches + def _schema_node( + self, + node: etree._Element, + seen: frozenset[str] = frozenset(), + ) -> dict[str, Any]: + """Convert an XSD element or type into recursive JSON metadata.""" + kind = etree.QName(node).localname + result: dict[str, Any] = {} + + name = node.get("name") + ref = qname(node.get("ref"), node) + type_name = qname(node.get("type"), node) + + if name: + result["name"] = name + + if ref: + result["ref"] = ref + result.setdefault("name", local_name(ref)) + + if ref in seen: + result["recursive"] = True + else: + target = self.elements.get(ref) + if target is not None: + resolved = self._schema_node(target, seen | {ref}) + # Preserve the local element's occurrence constraints. + result = {**resolved, **result} + else: + result["unresolved"] = True + + if type_name: + result["type"] = type_name + result["type_name"] = local_name(type_name) + + target_type = self.types.get(type_name) + if target_type is not None: + if type_name in seen: + result["recursive"] = True + else: + result["definition"] = self._schema_definition( + target_type, + seen | {type_name}, + ) + + # Handle anonymous inline types. + simple_type = node.find("xsd:simpleType", NS) + complex_type = node.find("xsd:complexType", NS) + + if simple_type is not None: + result["definition"] = self._schema_definition(simple_type, seen) + elif complex_type is not None: + result["definition"] = self._schema_definition(complex_type, seen) + + min_occurs = node.get("minOccurs") + max_occurs = node.get("maxOccurs") + + if kind == "element": + result["min_occurs"] = int(min_occurs or "1") + result["max_occurs"] = ( + "unbounded" if max_occurs == "unbounded" else int(max_occurs or "1") + ) + result["nillable"] = node.get("nillable", "false") == "true" + + description = self._documentation(node) + if description: + result["description"] = description + + for attribute in ("default", "fixed"): + value = node.get(attribute) + if value is not None: + result[attribute] = value + + return result + + def _schema_children( + self, + node: etree._Element, + seen: frozenset[str], + ) -> list[dict[str, Any]]: + """Collect immediate elements from XSD compositors.""" + children: list[dict[str, Any]] = [] + + compositor_tags = { + f"{{{XSD_NS}}}sequence", + f"{{{XSD_NS}}}choice", + f"{{{XSD_NS}}}all", + } + + def visit(parent: etree._Element) -> None: + for child in parent: + if child.tag == f"{{{XSD_NS}}}element": + children.append(self._schema_node(child, seen)) + elif child.tag in compositor_tags: + visit(child) + elif child.tag == f"{{{XSD_NS}}}group": + # Group references require a global group index. + group_ref = qname(child.get("ref"), child) + if group_ref: + children.append( + { + "kind": "group", + "ref": group_ref, + "min_occurs": int(child.get("minOccurs", "1")), + "max_occurs": ( + "unbounded" + if child.get("maxOccurs") == "unbounded" + else int(child.get("maxOccurs", "1")) + ), + } + ) + + visit(node) + return children + + # pylint: disable=too-many-branches + def _schema_definition( + self, + node: etree._Element, + seen: frozenset[str], + ) -> dict[str, Any]: + """Resolve simpleType and complexType definitions.""" + kind = etree.QName(node).localname + result: dict[str, Any] = {"kind": kind} + + if node.get("name"): + result["name"] = node.get("name") + + description = self._documentation(node) + if description: + result["description"] = description + + if kind == "simpleType": + restriction = node.find( + "xsd:restriction", + NS, + ) + + if restriction is not None: + base = qname(restriction.get("base"), restriction) + if base: + result["base"] = base + + base_type = self.types.get(base) + if base_type is not None and base not in seen: + result["base_definition"] = self._schema_definition( + base_type, + seen | {base}, + ) + + enumerations = [] + for item in restriction.findall("xsd:enumeration", NS): + entry: dict[str, Any] = {"value": item.get("value")} + item_description = self._documentation(item) + if item_description: + entry["description"] = item_description + enumerations.append(entry) + + if enumerations: + result["enumeration"] = enumerations + + for facet in ( + "minInclusive", + "maxInclusive", + "minExclusive", + "maxExclusive", + "minLength", + "maxLength", + "length", + "pattern", + "totalDigits", + "fractionDigits", + "whiteSpace", + ): + values = [ + item.get("value") + for item in restriction.findall( + f"xsd:{facet}", + NS, + ) + ] + if values: + result[facet] = values[0] if len(values) == 1 else values + + list_node = node.find("xsd:list", NS) + if list_node is not None: + item_type = qname(list_node.get("itemType"), list_node) + if item_type: + result["item_type"] = item_type + + inline_item_type = list_node.find("xsd:simpleType", NS) + if inline_item_type is not None: + result["item_definition"] = self._schema_definition( + inline_item_type, + seen, + ) + + union_node = node.find("xsd:union", NS) + if union_node is not None: + result["member_types"] = [ + qname(value, union_node) + for value in union_node.get("memberTypes", "").split() + ] + + elif kind == "complexType": + complex_content = node.find("xsd:complexContent", NS) + simple_content = node.find("xsd:simpleContent", NS) + content = complex_content if complex_content is not None else simple_content + + extension = None + if content is not None: + extension = content.find("xsd:extension", NS) + if extension is None: + extension = content.find("xsd:restriction", NS) + + if extension is not None: + base = qname(extension.get("base"), extension) + if base: + result["base"] = base + base_type = self.types.get(base) + + if base_type is not None: + if base in seen: + result["base_recursive"] = True + else: + result["base_definition"] = self._schema_definition( + base_type, + seen | {base}, + ) + + result["fields"] = self._schema_children(extension, seen) + + attributes_parent = extension + else: + result["fields"] = self._schema_children(node, seen) + attributes_parent = node + + attributes: list[dict[str, Any]] = [] + for attr in attributes_parent.findall(".//xsd:attribute", NS): + item: dict[str, Any] = { + "use": attr.get("use", "optional"), + } + + if attr.get("name"): + item["name"] = attr.get("name") + + attr_ref = qname(attr.get("ref"), attr) + attr_type = qname(attr.get("type"), attr) + + if attr_ref: + item["ref"] = attr_ref + if attr_type: + item["type"] = attr_type + target_type = self.types.get(attr_type) + if target_type is not None and attr_type not in seen: + item["definition"] = self._schema_definition( + target_type, + seen | {attr_type}, + ) + + for key in ("default", "fixed"): + value = attr.get(key) + if value is not None: + item[key] = value + + attr_description = self._documentation(attr) + if attr_description: + item["description"] = attr_description + + attributes.append(item) + + if attributes: + result["attributes"] = attributes + + any_element = attributes_parent.find(".//xsd:any", NS) + if any_element is not None: + result["any"] = { + "namespace": any_element.get("namespace", "##any"), + "process_contents": any_element.get( + "processContents", + "strict", + ), + "min_occurs": int(any_element.get("minOccurs", "1")), + "max_occurs": ( + "unbounded" + if any_element.get("maxOccurs") == "unbounded" + else int(any_element.get("maxOccurs", "1")) + ), + } + + any_attribute = attributes_parent.find( + ".//xsd:anyAttribute", + NS, + ) + if any_attribute is not None: + result["any_attribute"] = { + "namespace": any_attribute.get("namespace", "##any"), + "process_contents": any_attribute.get( + "processContents", + "strict", + ), + } + + return result + + def _message_parts(self, message_ref: str | None) -> list[dict[str, Any]]: + """Resolve a WSDL message into its parameter parts.""" + if not message_ref: + return [] + + message = self.messages.get(message_ref) + if message is None: + return [{"message": message_ref, "unresolved": True}] + + parts: list[dict[str, Any]] = [] + + for part in message.findall("wsdl:part", NS): + name = part.get("name") + element_ref = qname(part.get("element"), part) + type_ref = qname(part.get("type"), part) + + item: dict[str, Any] = {"name": name} + + if element_ref: + item["element"] = element_ref + target = self.elements.get(element_ref) + if target is not None: + item["schema"] = self._schema_node(target, frozenset({element_ref})) + else: + item["unresolved"] = True + + if type_ref: + item["type"] = type_ref + target_type = self.types.get(type_ref) + if target_type is not None: + item["schema"] = self._schema_node( + target_type, frozenset({type_ref}) + ) + + parts.append(item) + + return parts + + def _operations(self, wsdl_path: Path) -> list[dict[str, Any]]: + """Extract operations and resolve their WSDL bindings.""" + tree = self.documents[wsdl_path] + root = tree.getroot() + target_ns = root.get("targetNamespace", "") + operations: list[dict[str, Any]] = [] + + for port_type in root.findall("wsdl:portType", NS): + port_type_name = port_type.get("name") + + if not port_type_name: + continue + + port_type_ref = ( + f"{{{target_ns}}}{port_type_name}" if target_ns else port_type_name + ) + + # Resolve bindings by their QName reference to this portType. + bindings = [ + binding.get("name") + for binding in self.bindings.values() + if qname(binding.get("type"), binding) == port_type_ref + and binding.get("name") + ] + + for operation in port_type.findall("wsdl:operation", NS): + name = operation.get("name") + + if not name: + continue + + input_node = operation.find("wsdl:input", NS) + output_node = operation.find("wsdl:output", NS) + fault_nodes = operation.findall("wsdl:fault", NS) + + input_ref = ( + qname(input_node.get("message"), input_node) + if input_node is not None + else None + ) + output_ref = ( + qname(output_node.get("message"), output_node) + if output_node is not None + else None + ) + + doc = operation.find("wsdl:documentation", NS) + description = ( + " ".join("".join(doc.itertext()).split()) + if doc is not None + else None + ) + + operation_metadata: dict[str, Any] = { + "name": name, + "port_type": port_type_name, + "description": description, + "input": { + "message": input_ref, + "parts": self._message_parts(input_ref), + }, + "output": { + "message": output_ref, + "parts": self._message_parts(output_ref), + }, + "faults": [ + { + "name": fault.get("name"), + "message": qname(fault.get("message"), fault), + } + for fault in fault_nodes + ], + } + + if len(bindings) == 1: + operation_metadata["binding"] = bindings[0] + elif len(bindings) > 1: + operation_metadata["bindings"] = bindings + + operations.append(operation_metadata) + + return operations + + def generate(self) -> int: + """Write one JSON file for each WSDL document.""" + OUTPUT_DIR.mkdir(parents=True, exist_ok=True) + count = 0 + + for path in sorted(self.documents): + if path.suffix.lower() != ".wsdl": + continue + + root = self.documents[path].getroot() + target_ns = root.get("targetNamespace", "") + relative = path.relative_to(self.wsdl_dir) + + # Preserve subdirectory names to avoid filename collisions. + output_path = OUTPUT_DIR / relative.with_suffix(".json") + output_path.parent.mkdir(parents=True, exist_ok=True) + + metadata = { + "source": relative.as_posix(), + "target_namespace": target_ns, + "operations": self._operations(path), + } + + output_path.write_text( + json.dumps( + metadata, + indent=2, + ensure_ascii=False, + ) + + "\n", + encoding="utf-8", + ) + count += len(metadata["operations"]) + print(f"Generated {output_path.relative_to(ROOT)}") + + print(f"Generated metadata for {count} WSDL operations.") + return count + + +def main() -> None: + """Generate WSDL metadata to JSON.""" + if not WSDL_DIR.is_dir(): + raise SystemExit(f"WSDL directory not found: {WSDL_DIR}") + + generator = WSDLMetadataGenerator(WSDL_DIR) + generator.generate() + + +if __name__ == "__main__": + main() From 872f2bb7540e15561805a127d1332d8e4023c3c7 Mon Sep 17 00:00:00 2001 From: kaburagisec <135169292+kaburagisec@users.noreply.github.com> Date: Wed, 21 Oct 2026 03:07:13 +0700 Subject: [PATCH 33/37] docs: Add prebuilt binaries section and installation instructions to documentation --- README.md | 27 +++++++-- docs/assets/onvif.png | Bin 0 -> 19280 bytes docs/misc/binaries.md | 137 ++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 4 +- 4 files changed, 162 insertions(+), 6 deletions(-) create mode 100644 docs/assets/onvif.png create mode 100644 docs/misc/binaries.md diff --git a/README.md b/README.md index 24cbb321..4bb8b7ba 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ This library simplifies that process by wrapping SOAP communication into a clean  Linux | AMD64 (64-bit) | [onvif-linux-amd64.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-linux-amd64.zip) | +|  Linux | i386 (32-bit) | [onvif-linux-i386.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-linux-i386.zip) | +|  Linux | ARM64 (aarch64) | [onvif-linux-arm64.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-linux-arm64.zip) | +|  Windows | x64 (64-bit) | [onvif-windows-win64.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-windows-win64.zip) | +|  Windows | x86 (32-bit) | [onvif-windows-win32.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-windows-win32.zip) | +|  Windows | ARM64 | [onvif-windows-arm64.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-windows-arm64.zip) | +|  macOS | Intel (AMD64) | [onvif-macos-amd64.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-macos-amd64.zip) | +|  macOS | Apple Silicon (ARM64) | [onvif-macos-arm64.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-macos-arm64.zip) | + ## Documentation For complete guide, including usage examples and API references, please visit the [Documentation Site](https://onvif-python.pages.dev/). diff --git a/docs/assets/onvif.png b/docs/assets/onvif.png new file mode 100644 index 0000000000000000000000000000000000000000..1aa060d74a46b25450eb403dd86489770f026f16 GIT binary patch literal 19280 zcma&NcUV)wx-Xmnp_kA*geDz=NJlz|D1y?Zg)Y5A=ppnXRRmEfqJq*pNDCbi0i}tw z07~z@bC>RY_CDwC@7(A6BTur{%)ImVd1vOAINb+#$cUMUK_C#>T}`z|AP^Y%2?i13 z17BudMfM;NgvwFh*vDA=zO0SAtB94YyS1GN($xcK2Z7`jkseky&UQX9YdZ%=x7(cC zO>LYoN88(+MiSa^Z4XtuCyttdUUqtc5AR{`T-txqL1vn-F>}m?9~12+H?TeR@KYS%EwL(_}u2a3BM^RECv_8 zDW(s`VsOf4b#f3=$YZ>@i4*8{=}nBpHK|5#V{uB(-Uospxh z&y#;s`**{AJ2!{_X!&C$7vDc_Zs6t!*!AXL7XA)0{&yQ7BpfdK-)1uT&$d6I1C#&j zP_mki-ahVL0e@fpBcAl^Jpb|Zk4G2BzkvjU{dFfMiU@{p!i(aGxB!xYts2sH`EXW^sY^PWM*^6*WB&-U(MlY4`-G@XY9Xw-x+ znbt&$B%Y9?-w?i$VM=%`V6kkMr>+l%NwXXKIBo52 z9RIiUn^n)gUR`e%=P(@^6wBcZUp!$b4?)aDmd9HKvoQ2baQtAy%3FRB-RSIlxss7R z-bBEgVo>;>aai=nMR+yT4ubbtrdxdW_;!+$D+<&c}Tv0S*fJ# zDv?V=maV3l6MVlQx~FKyJg7zSsOIRyrx5qKpf$s>mh;}_M+VCq)k9??wc{4+_2U*( zy6`dSjY&%<(0M{%Ai@$+8(TtWhlZVyt*h&8=T?pFic@CyX@ijOSEi5q{0{3l-e&mPAn~Jk_p$_FXQ^ct?h1Ckf%;P zrfh~UUYQ&^R2VAZfxEQUj4|;If@)B?9~vcHq0sgjEv1u|TCdv`1|>7ZF6uu7Dh|)K z<(Hp-Q_Mhjzu`j>b*745osoL*c`$h78JoD5nkS2$FF3prA+_HCwJ7O$0uE z6t^NiET@9&YJJ7|mJEIDZGVFmj4j$RaW`J+#eOwWE%(UWI$PJzVA78v88H>gj78h_ z=Wm{AJ#i7cdoRjD?0fGp0jY-HVd|Bl71J`;(LK|0?oHy>Cps1MKq)$X6u3uKY0 zgN2|vPL|F1$mg-I@K~rI9n|KII7W)0*G?)7$sD2HV@!mu_LNm?5-(JWSai}$wI}$y zAO6OTPU<#gAFHHjx?w`T75eS*ZmyWLIzmq*wH=KNr-%p36_J{i>@#75vEnUmK~t}; zpFnT{vr+8+s<)^jM-~wBa#qntvWH-o8KJF+m^H~;6nVdZJhEDh>E2g=%C&!*QN=`f%}=5f!&^JNYJb&3o$$+;a_zwDwK!KvUV8ZpE8Xp<9( zs2T2niktK;ZmuC+L_1ZT7_I2fj5?%l?G_5S{M<~6_8|oMG#R{k8A^2TN1iJw zd?~!Tt3olTles386IMQ{*&^Lkyq#B?l9ZHXeR2DXl(SAqOR8 zsFve_?y$b%Z15?I7Nk@M>+jTzlp#wnA26M@Va1kQ0%#|ibp_@R1dZF~cE`n^C3b)2 z-8u-VwS&&aI7h1!sf`NV_ftp|oUV}VG@7BRq55ddH+H42R?5*w8?ky!Y4gZ0Z>+k> zANP$Mq5vbeo|j6~HQm5cNZ2YdM`DN*kF$e3Tb(ID`N!|%A>mg=5i!mTP^2(ozG|bF z?LpT4A87`N#pTK1gOZ`0)-_q(O38~B^gA*5OD;`I>S)#b{)=AZ2fnx+3fxi{ay<~O z(K{we_+Xdk&`;`M5hF|wAISQ$q%BcJO zaX!Z5N#OG|cj|?W7?%)lLsV+CxTCji&qB7vO}44QN_hfS*G`_C0z(o>3;8|ns&8|dLaOkWFL?NqlnCRov2y8!97d;!;CgNW*|@oo zJ}qU3wO-Fpb!3zC+93`c41V1~FP`uVA)|JMF{Y?$AbZ4{y_Xl?0w?13<^+scVbpuF z^iYaKy-#<~bU&!u+?RJtR5WmWK3G^6_{eJ_;JcRPs$xP>(7E%|-Cn%=1>w7wD_1pF zVot+lqUnbj8tcN@(Ra&~?N|cN56lxE=3d6QY>dVISUIPV$qkuD>;-uzARs4vN*i5I zhhlvxafZl*pkX-jbjZEzTISHI&7QB4v7JE#$xTs6h(s< z%0=8~pr0<<)gEI^!|yk-jXq|kIP;&t=&!kSb`OjkhNY)^b~S$o6KnUFG-NX)ifuG| zUF?MLq*TLtp^^haxfn=M5ZU5QvqHBh#2K2K2ZVUi$9{P(Ps*SglMn%7hgi(5*STA` zIEn06f!72O^A{(ocrz_U&NubUj>Wnppbq6X!Zk-6VLw#l7@;}s zLG~`e4Mv9s_0&AgsvRDx^m|1qhz1d2XQV=gu9bvJs%Dq%QA}l5FLg$Y?^1{~9^5v$d)%misKS-Mz1o;UN;j#6b{3o|kdUm|>lB_p{_&a?X{te(?M zl(UVhofemNl5G|!xH2{|rPjX>KaxO9Zt@htYjBaw2eU-6T|)5 z-b9*)LXl8fc-08W<^38`CIz_)4!ID9NR_;mM7$HGyUm)dpLdGF%U0oWKI>jrfk%rU9*8Jtt z{fFXNn4+a9N(uBcDjIh=;2m8U&q@?`tPKKKBN8OE0%nYNg2I-kEJPoP_20rzz}jd8z1YReu8Vy!7BxeY&I4l_fscf)?{ z7s@b|1P$DI8Xjbv8qwX4-{l7KhFWV|2t|VTXNQkzBRfjm?^uDK1VfO1n^}F05 zX~2uHMimtsle9rZD6P_CU490SFJ1>&>39S;Ohi-6(f-n;ro~yO9NN2w#d~$_USfIc zS9+w6SSsZ_Jw_Y|ao4HCJLFd&6nRs1(vZZQ|6yHF0 zZyeo zDan|*SZp%*)#M3=QEN#&?UjruKALu5#YtF}f8?|YO?acVWY7Q_JCedIclDpn$?iX# zIlcYjcLFYX*mkIf-)m6SH_dC9bswCT!5n8Al&ZTnXmey(^jl)v1*sT(tG;LYMS2R-)2fBy*VBENj69-=_Tf{Q}MNd!Ln zDFTfefj*zl7GlC`Sw$6L^0xC{94FRNFa|kh4-$5O-SW}`G6#9yEkuRI7|XCrFFLy` z?ky(-JP;%zP}oSELWhWOmW%(m%se@=#Cx#fJ4H=x_d@jjgTFKR-{ZD0OGONsQ8oOL^3M^&D|>s<^Hj8B?x(L zdH!Rpw$-3r;}Io=E_#c(aMJX}saD_N-YiXP!h|cqAg$o`Y5!Ex$(Tycy>?i3=>uG8 zI)^vxHEQ*jL_0q$>TgTPF=;==kv^RkCIHPzMhEpoI0Z_HKjmwb{VG}N@*XUJk~86DA^m;*1U9^cv6nNnznu(dW$}23QX;B?q@!A;_Q(K_fd~EEY-KZYpAm>fl{GFsX@7qFu7$bO`T0 z%{%+<(i`UqVK*Tp%GG0yxI2E>sKh$99zX1d7Ps>zuIAo1V&90dzxL}`9I(NOlY)&W zH@x?KEyDQTr1Gpic?}ii*_w0sUB%^>Igxw+I^4B&=6nvvoi24>;rguexk24* z&6~+Jd8jl!vX9Wc8u!PK^*TkljvygoY9In++`oK*FSV#KO1+4hd%`C$*Y>nu={q{t zYBK-Dq$SbU#{CSxD~W1+0b-?PysQ*z>{)|SN%N9-dC(J%lN+Qt>_|2bS&wDPnI0U` zZQm(}=ViBmV#lodZk}fD`3J3vBGBO-`w*_I3z0>g-XrZ>mo2`!CL}3! z!#DPKi-}<;XJ?^Kyzd?2J)}9Io)P0O~Hoyuei7LB6a%__R4lcy0;3@c{hF zYxa32QM2gygdTMOO>mzBGS&o@3evY~*N@_TO(BlFk59b$jEG$oN7s|2!%gnNq`ojn zO+ldJp5p#T)h{_mdXe_U`?s*{D7nNHI?>m+?jhdLVEEZjc0FT*nQZPK9NM&N<%=zj zT-JPMw{6P58E`WV#l12As>qt%(^J=p{zb?;JakIT7c*l~9)f^-Sbyu^kles-j@**# zRT?2kcIlucC>KJ`sC-O^Gz3zkN|=_$N$zkkFF+(V|Pq^8DU~@?MIzvLOaGMoH{1BoqiL$WbUCJ4q9RJEH`Ybm1dc18t|tSp zeMr+#4xXXzJfw5Ny;p)eC&_I)*wO?f9z+k+hFLMgmOE{o&3R}cT$~Ad-v5m{R@9fo z`Mi|x#dq5f3(Wcp$%c4VkEAm8W#{P4e&`BjEh{fgyZRRut~w%& z4qCkg$p8=AYWq4lGeX2kDt6_Uc_lfIUdB!d)w zi&JOP+$#g2Cak4zWN#}gjV-Xg-e$MI_9ziczqo>33<~I~<=-^~LrWufW+jRr)5q)d znI$5>5`^0*o?V=0d^ZzhQK-Kr!jww*o$F)AB#xv+g+BC5B9D?Ezi;R1$udCSJkJ10 z+TWKP>9uQ7vUyKwezC$9iJyH);i~D_F^0}@d>tmRogs?X|0w8ssdMP`OTBPAmp~RL zu%-}z=eULREam;ccYsh9bY63RAoK!9dUb<+c9NkQVm$SPfv2M9#e@}(oBr1m_#Yad0E4K(H&f#*HVSpDpt`SaWU@iE5I&FDR^(3Vcr+qp3y+VJ@ai}sU!KK4*I@?sp zvvbNB+>T`_`gzeGtiiu?3&KC)`Grl_`Q1bFJOuUZI3>>2*zB0aUmGo4JRDYS^0==_ z+{snCcWz0 zrio_YS0`8O@-*{4x4)3ch)J1hxo1^ItcqSWzi?FIdU5%bal$^&ShFD2GiZM7mS%o? zyurK?rA2JtmpccV#LqdJ=dMWe%5-NLzZyC`>()Y13Zkgzt|R15&4UcV0{Y7ev6APP z0orHp7G6DsM=Y{Ut)yAVdLitYP+XvhsyKDETc5KI!5Bpx-Y|qswY3cm%?2B=&@f}X z87p+?BU?~IlBTca#)c3xaqryJ1P;auG(ftSV6@v`!?ZhhOQwr?J5bc>u#+}OSGp6`dJDi-IS!WAJrX@QQ zd5frvH<*vQ2;$9fF|tF2+)8FGux)5)ANgniXnstPoLWLRg9JVSPL@ADIc#Gc6X!Q( z{NcB_v<2)T4RK4EKFN7}{YiG+0_-NaCL=t!=`cjwElXgAegE*rFOpwDwIzn^-|@n8 zx;q`Vs|(^oH4IY_IJR`?!42_nd9~LRnIuxo(r2$6Sa&QXZllrYi3Q?>(QxsXrGxDf zhZ*@m>bsb;bXEH$pVFesQyIZuW)7mhIMo`r*xC0Dx#C;@77zP`->H&N7N&k{?L2K2 z)LyZ>u{eGi6rz)lc-QGpcV>j~mGG&j_n75-6a{P^tL6Di3rZo=A@ zNRGY-_R|x`!nHm9&Ym4gMkS_|iIR=+~vz=R~P-QclSV zcY{{#R9HJAp@RDwQZUz=RR^RhoHP(Ib3=3}T^q~E5ApJ!Lk!-fj#(jQMGwk%c|{I9 z3(aKRV7pbeFvV<*&egZNhrBoT@~Gl8?<(#h%~a$!ilbcECpn&<=N=9OW&XT`*r-;I zP2#cC_PM!%$B#d4s*k-Z>BK=wRZ#qrk+u>i>mW*AV+-DGp?4#?{;e)eu>F{fD6Kv{ z%ki1tVXfh;USt~rXU7_`%z6HUfHx?i1E^yv!~Dnau_h@OTbNJl3(R0K&OBcw#APYp zZ(Y~)SppG^*o7oN;oRU^C>kfVA}BM%5_W%jDG?$_(c;!b&|DZ@mgHV1n^46~_YS1? zYvBGc?Rxp;meK&(m;MA-gBm5_Lz3gqoncxlzLQ(X5bQOY(RtDJ<;A_|X78G}9Rr@_iH&^l4za6tK z;iE7ULkey)ne=DoB*bePK-I*0$W6%l-NiS_Vx>Ew67+yfK@Pfq7y%==8HTDgnwPzu zKGlC;WKBgXJw59(&$g<M@z%E&B-L6dWkhn{DJ+^cyQ&fMn<;_#3xwCO;MYfQ#d`)R&p# ziK&`I>1uqJN3c(C$_W*1QWYL4xAT2lue;6&{2nydoRV;443lj-~?(t>$G?N%_7Udzd7Us#>S#$kYz3 z`A9)Av$fO)tO4j}o~ZqJe0Yq_8yo~^XRkh!6;ED<=Uh6xCZt#;eDWST=gsYsTE-Wd zNR-drX0z>$g5Z$ddlw~j@@8QU!N3~Q#yeM@he(uW&YY=dxX1;n)4AJ?h-4a+*pfDi zXh|-#QoDBV!K+sWl9uwkr=;xWL?I7&&m-%0k^MAkc&iDr>=~V5v3;jOdo#quJ#j#- zXo`KM?q`D-S~DFm1W+GvWQ>mXX1`}jc83(Xk_fs2u-W43zCVN{d2(dV&0h;JvEP_x<-KU+GgTWnlZw!RVAiT?7nN zJ)E~hsc*|sdG(3?l+0r*xK&TNo%;>28Rt!yWAPEiHk{sil?klTPj_1e>qZ)HYsKn) zD%-m@a8vU2Ouk!4$^0zgGflLddzC_jb!@)Id<1*IR!IHOvK$~5eAYmfoq5^qCIw{Y zZN1rdJbkpX0?9drGU(fC^KN{~;5`?GJm|qj&KmgbM}?$m601%tV$BN9+^nHY5xy+j z6XD*bgpH+Pz}i@|r%QDpwFlp?LT)r?m#Yqq2XN~8`omn83Te@_>Kq?B%_iPzhBND# z@gTqU=7hC9+9*IYV$n=z(vD^LO$HzxY2Rwfc{Sm#JbUx#mj|k`GPED7#k@t2Qq}Q- z**V6HqHBmYgKd@1=ql^FE=itKD|}fXiOrFoa8vO%0o`HjeB2kM@cX!U;P!Hz0}gXq zuaviHU7w(NWoL`-je3zo1N-?jH238Jqq?KI4a;WPrM>*gmL7qa z3x-NVd=8hBz_EMFpYOKc|4!}m9zo?*tHhUMG_7Q8f_SB}6aV{VF7jLZ)Y7>=G4Xpm zU*p;)9$W`N0OZK~DXzVm`+b65B_t^P=WOT;UUl7C;svJ`0RlKy>#bxU>9;pKBW<;H zVsZZs&Dfq=&T zjvT&;o~Tvb8;b3@$8{)6v7%BiOqgPPzDpD5<5K7ds1#)#0-E=xZ~hf-_cg5Dt6Osh zl~0WIEWh3g<=oR$`g*c@0cTU<8YQ5)_uzuxQgNLmbBWoDaN+FAMXubIcI6~5HaK)P zIX@5452V_1{LsoiH?}bs-y>!}>moofB7A$Fz%s?fp?d=7@9cjglWZj-Z?z2!IW#N` zCxl-Jr{R2OjQtEbDTptf;x=z~%A?Zg zWgH?Y*fis6;WN;$UwN%}8#DyT?QXBAuSfhy>lqQNb7W@Ey| zH+w81f(~`}y$YRIf)?!6$g+Bfp?EVn#TuF|AGc44R5|)FUY)!7jPmGhtUu>oi@L%y zG}^IUa~h=#fw9o4gmz9}z`Dl*L8oaJr969S^PYaZMAZuPvjhoB^faFZ3BLTMZ(ZU@ zn6awOLp+94Nx}3$$$`J?6JuEz4JVbiCV(2Z{CMUnP2hO4)HURFa{ zA=ggo_{Ri^-|#k7y3EjTK*WZmK=epr3xV(#!CW4O-v`HLkf8)-88zh>iZ^3Sq($+a zT#2cd)GP$>nG8wowUio3L~0dzNF1rE(r`VBVTxwII{EmrB+VYFvNKYo@PllAq|_ZA z4G%QYskGr6#~d8+#BGrDKC_PHP-9)Xr^Wq+vS{#X>#Q_4?9!?cUx3f}YGrJ=*8@^9 zZ#QSg!x>{#e9T?lx)92@q!>JizT)O!hY>vFP`ll9F8MQ_!4RqzS(*?`2!V{m%7z}t zNSVHVvBMz%qLfjK9CKWJkWTd8T^v>sM?b8h{hoz$-bmsa7p(hY_wW*JfL-mZcmQ1U zqci>tJ!^ zqx`VQ0c163!j8whFj9_jAZq|1y@9n1IFgu;ZZ3_yo zREFj%+64FHd45B|*VktvW}>_nGv@-ktfh2?__7Q~tu8en!ysf=LTepGg(#`v1?2nE z%RrJH6Ei$k(!P zm`vr7I?y##1-c~fkfi{j(cg|^o1*xRxn2!T10WP)!<%bom*p`SaBNAr{dUyxH%=vW z{AW9BQ3`>SsMum$hI5ZnqN@-mdQJjKfussr1}&=}H9RL_;|Cxh2~%D_)Kgq<_Xgpt zKNS;G$>hNaRGe$LewS|b{wTC%_gzF+6Y(co>E{fOZw1m*R!%CQIUYlcq4SFA(s+3; zS0)u{5AQHQYalSgaRPeQsd!0j?w62tX!CaOM zX&|~4)_ZbdYfUciDg^{G0Tro?BI19v^UG|40i*qVErroTFpc21z}ddtvKJAQhe z73@d;;;aYJ{DIAzK;M!whb#611m(kb-oN=v#6gMrX*b}PyG5$_ZUh@`T9JqCQc`5% zi04iItJTKg_?njKVP$tp2{{9vq?zWW@=zM2#dG^ISmKC1N#rNaL%b^xVKkmovYpfH z`_O!a!cx7ZNPWs4d&x`Ro*p5&OYo^K_svOx9QJ2Xs0tF^0R3>L`w#>XWcB@wX)P}4 zThl0@6h0Qc1#~=A=GwWUPvZ;=uhV zQQdXgkhXs)iw8GI3Ngmgd%f(P2zhrTWK<@#zc;pK0IPgBIx)mJ%pVnvjB$fQ@H^sZ26 z!Ou$B!6{ahkz*Klr$Er3%ydShR9hYXqnYyx|0a$>iK5#kt75deT0FGt(3MGgTqEvj!#4O7UdP__Lr$(1Uu}Q->9Tv+fY6(>&bkFLJfXqLj znxJb4TIz?rrz-FQqfgm;^#NoLZSuDi)PndS-kZ~{=?Eu3%bni+VVJ@f3Nw*#z$UG6 zgLFQ0E!-rk2ISwntYZ1_=sO;p0?9L89XNMpg^N3Mo?0CWR94AW?Fn>c8vDDmN|%Ce zxK6sBQ;qoB$aP4l{Z2I?*dx@s5l!172(R#hn>pCrK>YDlM&GL|qw?=oZP0y+(^K%n z*zU<4^xm=!VLLPUir8-8&IBh+@NjdgyBm~G-A$(d9CzDt?ijGY?C9CKCB%h3RSviR zy-u8>@{X!x*un1Zjo^s;;cB^-<)^$u=7}V@s(Y!AjbPm5oF&wR%An*!8k!Qb(bMy} z*&>m0-+(KAW!`(&-9*TbCtQDx80GYdcyD z@}L7L)y2hFte4YosI~KqP*)y>J?4JP1#%Qt@}r17*4^74TCT-cF~#*)yeJnHkOx*6 z^%*+QRCNpJK!t_p_lNBAw6pux84$$lYc@LK$%eh5r4YVfQR-e%&>l)*h;&|03{d81 z7fs^qs7oFumZX0DepNkNCfIc2ltk=^-UvV2mQn2(^XaSVa6b?I!GMZxJ)aw33gBQv z4D*SpX}VP_Wi!@hU1Ew&FGO`i5gID?o8C-FH~3TD`a>79-en5Do5OftP|$~62EUi7bi@C#Hx;oUdA#n20^PP~@enUQ=B+9lG56n9UCCtlut*I&ZlLac$HT zIG-Ajgq`d#Q(ch|7vz%gL(}89xj{;FGDTE@FFcOz@{$k?F=e7K&U$J=in3EHU@@0X zDrs!nBnvm?BH3O%2+&N*B7rWR;C^W4AEiH{BSf=F9qBU%FZJJGqEj|k>qeZ@Iq!Gn z=@;uJef&FK2-sVMo?Koyb(NAuZhCeYRC}X}Y{Oo|f0cPwh7?QDJ@mXPQSsO??LJer zPHmGiP@lg8(rSFWgN^>nJ+}=F_3Tk}>@yD-m;eF$L)BT4N?*n}`l5qqhdR3tC zdOCs7FuNs+U}bKm)P^J_>-b8!=hL)}rN)j=v46H^oErI{I!Qb?=m{>gdf#V>{TH|8 z^D>ebv>?*KrSQY!5b?JT%HJ?*Ji>Q*iRy61dBK z2ZkAzl@4BvNz3D^+>@uP!bv}+c#Ipn#+v|7`Eli>k6M#3lus=xtMyvp=ndNndy1V0 zSf`kasi;~+imeQqHPNym$eqhC`5$FN-pI8KeGUQr1;9@@`|^qFP&vdORDdm03?*p(hGmzXzadGu*>GesH%t?Q9TagaoOeAoQCFYW73S)*JZ zWC|}KUfz=jnD>c_w5h}0>Ry6eCS2qFT-(Wy#s)u7vgoZI*SEU(G_DtPx8{dxZq8I@2Caze~(g?`_VKaj& zxHEd0hXX2mTGB>U(a@=5Ju|XV;&&0p(c(e&cGP^&L{1Mcev-m4yh(C{F|UEB<>zqn zm&eRPsp%SfMZh6egv0#NCIh65%smZ)_^rj7Mp8b>{uwxZKuRz>sBB!LRodJ9wK@>R zl;E_RL?Jwon_2EDJ)D|zY(8y;p=(&#TtKx9VpP*E9K8bgc+LQv^TV*=Tx(Z! z*lb|WgUY=gvD~C`7A?LpgGZKPkEk+{CMu|7NrM(6TgYeL)mYSqVrU^5MGVvPP=OM{ zU~VRH!QYL?A^p7D@^1)?bSw0cGlb`@B@?d4oiQ4ITDH`l;H0pq56)ZL;l$Ez|C;C@nAqGr~6oNIhj1ZkN^(yYLwt zeLt69y{PgvZm(H5#0(Ig=bD2V1Wlo#n+p8-UsM8Z^JQx|b$Kw=UI?pu6+eEbkSSgI zu8wOd8~ajF2&QG9`?+OuY~eKn5a_}@gbR>Cu9-FZZDvR>jM@8WFhe2%;SA2AlBrwu zUAHiNT>`%d9>NP`C_H<}MN~zG4g8g9$;Zag^cPu4EMDXS3E>MZ-dos=ue_lPeq6yR z5J&;WIeaRy;yNK{rjGoRfjI~?nMl}EeSYKQoS!e3MtN>YJj8>#YLbz#IM`=}d`wB8 zLp$Tnu&w3yyQxwz7V7P?z8PqaQ75h-pD`71!6^aXo7-4g3kQw~T!?S9R)#w~E(w83z@c&2|GT(-pR=eNf8HJNrPn_sal6aVkw_a$QT=HD$VE^+edZ*Bc@Z;Ou zVV$3b%~WanhIbm2EAU5|B7$OTc_(&;iHSAhfiu868bhX+Re)D~B#3DMA>OvhIQ&9? zC5uJK^JiJ4JA=AtuvQ7Enh&B*+3Xe2XBk*O*tn{uVYI$boKUJJ^2=FosLOU>j-_&Y zpNBxjQ0%rC;;K`K7_@Oi6}t6$OE*pAn$dv>If04wC035w=!CB%8VzHjH;`^eLD zP0C3H1{;4F;TMA{KMSO2aeWy0nP&*)_bPW%k39d_Ce$K5a3$cNtY%TUCB|MFq}Po` zfASD1Fg>6iCTJDg=+cFFT-u3VzEi#;szlg7=_5}(2#-!6S98WtM|_Jh8b?6`aCyeE zT9?V6HKjaC-e*DuwzW4vHPtEKkjLjMf0gT6KUVqm>L;6>va&YdfXv~YnOMWQO#lMN z;%7}q0)hs$W-%sisAaWlf1~qEI0BO}B+g_s5lmX@5++H(ajausp;wP_56j<~c#=2% zMx4{q<4CMin7mjSBmt7*)?r`rv)>&MYFwR*7VkJW|0@?>dn3@!yXcMPvGV0^A}@BX zre+CHI4|M%Cp&0Y|5PDd%g&)p2Jh$KZ)qMP5qF8XD#Kq;5joRXv!R!$N5wSVP-S;e zeRA8i^PL5J<@&l6&{z1=u0&hatS8@Hc!8tP3G=Iu*OUYFq)pF;N$}f;kL|A>V63}H zJPQ1hjTkjd=dAiTYv2u%G?#Raw@jv6qeKm;BKqOQ(O_DjGoO zz_5^eK24&)Mf%*3pO-%!2w#T1@>Vm7xp_F@WOA;-MwtlN?&pR+)av9;XN#RyhF`jB z!Eb)!Bpg>(WYdYyPp*9P^UXBm*uf=M^G6Z4S`J zb(JhBdXuYc*iSFzTVNwTwA~|W-X&IsZ*blq0}uLY=Bwzl^H=N2?8}y8xQJ!iU6pq6 zW`9FHwK$B4weq{ltue8;5_jT)*iXZ&9^@g+kgOgnR5R=N*o7I1AEh`y0=w6{hOeK6 zui!*}QE8cdvKM1wdd4tGIfL*2x*GcG5q#DcKKoR+gOs6(ix(`h>8{u0A+OG(nIAr2 zU2#{eA#^*T?|k`^kc8L?K-L6E?;PX~7!}z@cHt_52%9&FSfdd59P9hgb zw{<>*osMH|@Obk@%p+LEa+grUyf7_Q|C1OMadvFK1cN@gNnqvIXZ@C?02*^~`DzOS zIRrBDG~|S|zShkq@H5AKy0V>++x_%F`HaEu%!D-!w5@hO0=wTd zsURd!Rry-gL%5kjRPOc7R1DWi4i8^~8iPGu^g#>yCu1pynmVhm?>;u-SYhE6?$X&6 z1dY7618vi?>8JFQwHW@8I|Gp@F;7Hfpf62%K9_`UaKrHAuV^UtGoJ zPLgT(aok$Cgg<5QjODnCZgY1;W^!r}5^}%Yj%jV0y=5l8%Jsgop7Q+EH>T~nZa?G= z1VYl~9NsIsd)xos6=XmU+~+{*#w6i{Pd~DwvZ)g2Ha_TJwR|qe;Wx4Eg|nIg?om@8 zPGMy@i#7QjHFshXl<62I*EI7St%l2m-g{CyR36M)tn*rDIZJ;v)c~ zRtUMr7CK90CY>9-zjvo@rr|Vfykur)8G{SUS_}V9-G-3n1Jkq6FkMxnUU(|BnY_bm z%cqKK&dbKjKG*0Zg6?~1oOAuCi$PW=Ao3w*(#rJkK-0vyUPi(_a5R+dK2|H>i zm73cr4a*s-1`ba}fjZ@N_%@FJ;|0?&;2L1)9(d!f(4G%W_ScP1IQ-3-r%RE9D8BKw z?Gs$uvk~!tTbpA+RyR)f{bK6j&F35fvXq)iHUKtWZ%~DSBwOuZQSzyhQs@dQrmawj zL7)i0MLFP~a98-nxzF@|UTcQCL;jrZ6DYKu8*-2~h!fW-ET7==R*;>?JQ?SGU}Z!% z*L#PFGhlfJlIitokINa{r>((4vi@ zWLG%|4c5ee6p!K0d+jtXC2*JD81jITsHch0i-N1E)f?M6*zko-Asvk-1?nFktc*=V zE!Ng&_6OG=8N!IoYIrA5kJ>}D885*kslYgkc{)9Qc5}dNrivnCrQ)xo4{#90AwdxZ01T3z{)2#ltlgF zn&^452Db)qLu7%ex-bSkK4`ZL3K`nIi!WBmr^c;MXG2P2J?fbd#Igs)UbCH4h-;X? z%}2b*pIl?1Xm&_c{b4gXZSz;#_*b4fB^pX{J~j`47+B8=KYI_8y8tRSim``0kNN87k@Fj-HY1>lBe^M+jE@qF-2OnuGxd@WQ6!4@vKiYu3P}DUlO=ZRYKJN`PSS9SEXajNC@~W@BFS zF95f8)eYcp*dQBiDeHH@1vHUX9$ z3Fd@;b##~9wcziTnEmPEJGi^vKtjw3I4?ey3R`Bw){nOHe0Ze=oZ2u++lqzUr&OSL z1)x*?2PUf!lLY{16}SH9mQIiSGiQJpdYweb&oF3)vpn~PJno5o^%%cta=8ak9nsHw zZT1RZRA@4qJ;MPmWL|nYzcM101Z4tkimb;_7sNg75N(nxnudYGP&y$!VE%LP1gJL=0NW~d zG;$$KZ5*2`v-=8g2cUH0VS-4)9Hh zZS*~oQ9tp=z5oK{e34DFeF4jLn;kDlVylw0{SKg-{k63cw;TIpm~!VW@5dfG*gare z{~v+ofy#maR}pbD>e}AP!qM0{&e~FTqaKsKw&5QS$7N};-;5?G1E7ghQ*P52F`g7f zh$~=-C?+)|ooOjV9blw+ko*qimkan#3*~{FHuC09IzYVU4{>@E^^+Vck=63oqHXcnv4`nscd#e`>Q`h3jNk?Ip2BMRc8YfZ~iimOR2chr%;~-J^R_5KNF3Q1TXLZV@kxX(t1~6g+$AtFTsORESNZ zyK?C|enB@)a-vZ^c1o2r+-Nn8`arX^8ascwo#WR}8?F?Lf0RPQgel+b&TuEJDc0t;9 ztfEW?kgdnfiQzhZ?xi>QX(tD;>!V9c;*M63%Sp2r`JWjn-g&S36r)vJ&Mu~F#iA$_Q$bE+TYI%6m6CD z1b~kKK#7~N_TDFt-tA|BL$1}Oc@z-uKHpN^LQyrHU zN?1msL^mbk5J$(TIF7JY3(ajVU9r>UER{QnntQdC+be99M5i+6W3_3ea}Ldh^Rcqi z&NKhM&-*-|=lT7f@9+10F5k!bDkl049r;q2y;0z(Ylw5SfBL7uY`b#em@Ejwgzw0_G8%rs zI9c$vri1#%KxqSlm>5SP+N%uB=V&`w8xaS9c^xb4>lNs$m`!kh!0`l2oXAi?~ zVLOe;N@)1&CQz`y6t+fN>T&bSZf57sEozvS?$(L_5-T|A=wzqN?Om!Liv7f>Q>;dS z8y~@zT9kFu7Kl<}Grw5G2nt|lBZ;FRBX~6F6n15VgNr>7-|~>Fyp;=yu~FwvTFpxs zpkgXR@}hly0X1s)wS)O?;g*ZqEKnu9sV1LBLm*n<2ZlnKY^I|F0im{+?|PJ3-18HC zRV=q$HiM^3ROAo2+TnPJUBC<0h0N8)RS*PhUBhY)88sj{rc6WS+8at+-8Ld1NaS){>0D_b=Fr+rN zS36f>p=w*2Ra5O)e{p*y)qPB-l#&qFBj_J)^7d5t?>*l_eN1zpy|7u4)#t3lLb2tr zi1f@C{hFmg5Z(3Y-yb=ffUg26kCf1dzFL&MjOZ#i==mBOI}1&M+o0X}G;_u4rEZ(5 zQM{8gp}Ic%E+e3&vvUf9e_VWow60!yP<*$$)oD6Hw{EWvq-FgGwobR3yp=#m%UHoH z&vpzrW0u!o(45pkpKBr~x@X{3)?$}G8bXeu2N4~#MO-JKLI*x^QbKkhUSgtunfKlM zU?TVS01l=HM8GErCEsqei;`05{2=acr>7&X{`$+i{LkAc!q6IPVwYt;mF!?>G3IgNM)R`*yh{X4pNt2tWO`Xetrn$jnnlYQE;7=446lwZ zy^&3C9_MUg$Nve={a0uM8ZiwUxYFw)sS)|U32wMg5EBf#qkSFZJ5h7SuoE0q&K0$K{E$Qk2ZN__mM zD)59v-yCK^NXp0Y2_G{Bp7pOLOvR>=F&qtD`B`|W8nOdCHXg%U{kOAp8?{SwYcp@+ zIvl1+b)wnQ_BW5q*^E&1%8Q5+?LJXv4sthk&AM|8_=~`eD?y4bqqeFKi>4k1logPG zK|}B}zSHaw%;E=MHgi$*Rn5|GANo8Kra5CAIFho?PJK$IL5@u75650pKGQygwZ}iu JugRC1`#*q4ubTh> literal 0 HcmV?d00001 diff --git a/docs/misc/binaries.md b/docs/misc/binaries.md new file mode 100644 index 00000000..0627ed87 --- /dev/null +++ b/docs/misc/binaries.md @@ -0,0 +1,137 @@ +--- +hide: + - path +comments: true +--- + +# Prebuilt Binaries (No Python Required) + +Run the [ONVIF CLI](../main/onvif_cli.md) without installing Python or additional dependencies. Download a prebuilt binary for your platform from the [GitHub Releases](https://github.com/nirsimetri/onvif-python/releases) page. + +Each release provides ZIP archives for supported operating systems and architectures. Choose the appropriate binary from the table below. + +| Platform | Architecture | Download | +|---|---|---| +| :fontawesome-brands-linux:  Linux | AMD64 (64-bit) | [onvif-linux-amd64.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-linux-amd64.zip) | +| :fontawesome-brands-linux:  Linux | i386 (32-bit) | [onvif-linux-i386.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-linux-i386.zip) | +| :fontawesome-brands-linux:  Linux | ARM64 (aarch64) | [onvif-linux-arm64.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-linux-arm64.zip) | +| :fontawesome-brands-windows:  Windows | x64 (64-bit) | [onvif-windows-win64.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-windows-win64.zip) | +| :fontawesome-brands-windows:  Windows | x86 (32-bit) | [onvif-windows-win32.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-windows-win32.zip) | +| :fontawesome-brands-windows:  Windows | ARM64 | [onvif-windows-arm64.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-windows-arm64.zip) | +| :fontawesome-brands-apple:  macOS | Intel (AMD64) | [onvif-macos-amd64.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-macos-amd64.zip) | +| :fontawesome-brands-apple:  macOS | Apple Silicon (ARM64) | [onvif-macos-arm64.zip](https://github.com/nirsimetri/onvif-python/releases/latest/download/onvif-macos-arm64.zip) | + +## Installation + +### :fontawesome-brands-linux: Linux + +1. Download the ZIP archive matching your Linux architecture. +2. Extract the archive into a permanent location. +3. Create a symbolic link in `~/.local/bin` so the executable can be invoked from any directory. + +For example, for Linux AMD64, assuming the archive is in `~/Downloads`: + +```console +mkdir -p ~/.local/opt ~/.local/bin +unzip ~/Downloads/onvif-linux-amd64.zip -d ~/.local/opt +chmod +x ~/.local/opt/onvif/onvif +ln -sf ~/.local/opt/onvif/onvif ~/.local/bin/onvif +``` + +Ensure `~/.local/bin` is included in your `PATH`. If necessary, add the following to `~/.bashrc` or `~/.zshrc`: + +```console +export PATH="$HOME/.local/bin:$PATH" +``` + +Reload your shell configuration or open a new terminal, then verify: + +```console +onvif --help +``` + +Replace `onvif-linux-amd64.zip` with the archive matching your system. + +### :fontawesome-brands-windows: Windows + +1. Download the ZIP archive matching your Windows architecture. +2. Extract the archive. It contains an `onvif` directory with the executable and its bundled dependencies. +3. Move the extracted `onvif` directory to a permanent location, such as `%LOCALAPPDATA%\Programs\ONVIF`. +4. Add that directory to your user `PATH` environment variable. + +To configure `PATH`, open **Edit environment variables for your account**, select `Path`, click **New**, and enter: + +```text +%LOCALAPPDATA%\Programs\ONVIF +``` + +Open a new terminal and verify the installation: + +```console +onvif --help +``` + +You can now invoke `onvif` from any working directory in PowerShell or Command Prompt. + +### :fontawesome-brands-apple: macOS + +1. Download the ZIP archive matching your Mac's processor: Intel or Apple Silicon. +2. Extract the archive into a permanent location. +3. Create a symbolic link in `~/.local/bin`. + +For example, for Apple Silicon: + +```console +mkdir -p ~/.local/opt ~/.local/bin +unzip ~/Downloads/onvif-macos-arm64.zip -d ~/.local/opt +chmod +x ~/.local/opt/onvif/onvif +ln -sf ~/.local/opt/onvif/onvif ~/.local/bin/onvif +``` + +Ensure `~/.local/bin` is included in your `PATH`. If necessary, add this line to `~/.zshrc`: + +```console +export PATH="$HOME/.local/bin:$PATH" +``` + +Open a new terminal and verify: + +```console +onvif --help +``` + +For Intel Macs, use `onvif-macos-amd64.zip` instead. + +## Understanding the Distribution + +The prebuilt binaries use PyInstaller's `--onedir` mode. Each archive contains the executable, bundled runtime dependencies, and project license documents. + +The extracted directory has the following structure: + +```text +onvif/ +├── onvif # Linux and macOS +├── onvif.exe # Windows only +├── LICENSE +├── NOTICE +└── _internal/ + └── ... # Bundled runtime and dependencies +``` + +The `_internal` directory contains the Python runtime components, third-party dependencies, and bundled resources required by the executable. + +**Keep the executable and `_internal` directory together.** Do not delete, rename, or move `_internal` independently. The application may fail to start or operate correctly if its bundled files are missing. + +The `LICENSE` and `NOTICE` files provide licensing and attribution information for the distribution. + +## Verify the Installation + +After completing the platform-specific setup, run: + +```console +onvif --help +``` + +To see the available commands and options, consult the [ONVIF CLI documentation](../main/onvif_cli.md). + +These prebuilt binaries do not require a separate Python installation or a separate installation of the ONVIF Python package. diff --git a/mkdocs.yml b/mkdocs.yml index 3b54c798..0c165244 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: ONVIF Python site_description: >- - A modern Python library for ONVIF-compliant IP cameras and devices, providing a clean, + A Python Library + CLI for ONVIF-compliant IP cameras and devices, providing a clean, typed API for discovery, device management, media, PTZ, and events. site_url: !ENV [SITE_URL, 'https://onvif-python.pages.dev/'] repo_url: https://github.com/nirsimetri/onvif-python @@ -81,6 +81,8 @@ nav: - Conventions: conventions.md - Quickstart: quick_start.md - Approach: approach.md + - Misc: + - Prebuilt Binaries: misc/binaries.md - Usage: - Client: main/onvif_client.md - CLI: main/onvif_cli.md From 0cf3ef92e5faa6827dfb274b8ee36a1b43a7c3ea Mon Sep 17 00:00:00 2001 From: kaburagisec <135169292+kaburagisec@users.noreply.github.com> Date: Wed, 21 Oct 2026 03:07:42 +0700 Subject: [PATCH 34/37] ci: Add GitHub Actions workflow for building Python binaries --- .github/workflows/python-binary.yml | 124 ++++++++++++++++++++++++++++ 1 file changed, 124 insertions(+) create mode 100644 .github/workflows/python-binary.yml diff --git a/.github/workflows/python-binary.yml b/.github/workflows/python-binary.yml new file mode 100644 index 00000000..0de0a036 --- /dev/null +++ b/.github/workflows/python-binary.yml @@ -0,0 +1,124 @@ +name: Python Binary + +on: + release: + types: [published] + +permissions: + contents: read + +jobs: + binary-build: + name: Build ${{ matrix.asset_name }} + runs-on: ${{ matrix.runner }} + + permissions: + contents: write + + strategy: + fail-fast: true + matrix: + include: + - runner: ubuntu-26.04 + python_arch: x64 + asset_name: onvif-linux-amd64 + executable_name: onvif + + - runner: ubuntu-26.04 + python_arch: x86 + asset_name: onvif-linux-i386 + executable_name: onvif + + - runner: ubuntu-26.04-arm + python_arch: arm64 + asset_name: onvif-linux-arm64 + executable_name: onvif + + - runner: windows-latest + python_arch: x64 + asset_name: onvif-windows-win64 + executable_name: onvif.exe + + - runner: windows-latest + python_arch: x86 + asset_name: onvif-windows-win32 + executable_name: onvif.exe + + - runner: windows-11-arm + python_arch: arm64 + asset_name: onvif-windows-arm64 + executable_name: onvif.exe + + - runner: macos-15-intel + python_arch: x64 + asset_name: onvif-macos-amd64 + executable_name: onvif + + - runner: macos-latest + python_arch: arm64 + asset_name: onvif-macos-arm64 + executable_name: onvif + + steps: + - name: Checkout repository + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + + - name: Set up Python + uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 + with: + python-version: "3.13" + architecture: ${{ matrix.python_arch }} + + - name: Verify Python architecture ${{ matrix.python_arch }} | ${{ matrix.runner }} + env: + EXPECTED_ARCH: ${{ matrix.python_arch }} + run: | + python -c "import os, platform, struct, sys; actual = struct.calcsize('P') * 8; expected = {'x86': 32, 'x64': 64, 'arm64': 64}[os.environ['EXPECTED_ARCH']]; print(f'Python: {platform.python_version()}'); print(f'Architecture: {platform.machine()} ({actual}-bit)'); sys.exit(0 if actual == expected else f'Expected {expected}-bit Python, got {actual}-bit')" + + - name: Install project and PyInstaller ${{ matrix.python_arch }} | ${{ matrix.runner }} + run: | + python -m pip install --upgrade pip + python -m pip install . pyinstaller pillow + + - name: Build executable (${{ matrix.asset_name }}) + run: > + pyinstaller + --clean + --noconfirm + --onedir + --collect-all onvif + --icon docs/assets/onvif.png + --name onvif + onvif/cli/__main__.py + + - name: Include license and notice (${{ matrix.asset_name }}) + shell: bash + run: | + cp LICENSE dist/onvif/LICENSE + if [ -f NOTICE ]; then + cp NOTICE dist/onvif/NOTICE + fi + + - name: Test executable (${{ matrix.asset_name }}) + env: + EXECUTABLE_NAME: ${{ matrix.executable_name }} + run: | + python -c "import os, subprocess; from pathlib import Path; p = (Path('dist/onvif') / os.environ['EXECUTABLE_NAME']).resolve(); print(f'Testing: {p}'); result = subprocess.run([str(p), '--help'], capture_output=True, text=True, timeout=60); print(result.stdout); print(result.stderr); raise SystemExit(result.returncode)" + + - name: Package distribution (${{ matrix.asset_name }}) + env: + ASSET_NAME: ${{ matrix.asset_name }} + run: | + python -c "import os, shutil; from pathlib import Path; src = Path('dist/onvif'); dst = Path('dist') / os.environ['ASSET_NAME']; shutil.make_archive(str(dst), 'zip', root_dir=src.parent, base_dir=src.name); print(f'Created {dst}.zip')" + + - name: Verify archive (${{ matrix.asset_name }}) + env: + ASSET_NAME: ${{ matrix.asset_name }} + run: | + python -c "import os, sys, zipfile; from pathlib import Path; p = Path('dist') / (os.environ['ASSET_NAME'] + '.zip'); valid = p.is_file() and p.stat().st_size > 0 and zipfile.is_zipfile(p); print(f'Archive: {p} ({p.stat().st_size if p.exists() else 0} bytes)'); sys.exit(0 if valid else f'Invalid archive: {p}')" + + - name: Upload to GitHub Release (${{ matrix.asset_name }}) + env: + GH_TOKEN: ${{ github.token }} + run: gh release upload "$GITHUB_REF_NAME" "dist/${{ matrix.asset_name }}.zip" --clobber + shell: bash \ No newline at end of file From d6326fac250f9754d524519a38a82e572f45447a Mon Sep 17 00:00:00 2001 From: kaburagisec <135169292+kaburagisec@users.noreply.github.com> Date: Wed, 21 Oct 2026 03:09:09 +0700 Subject: [PATCH 35/37] docs: Update descriptions to add CLI --- docs/llms.txt | 2 +- docs/overrides/main.html | 4 ++-- pyproject.toml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/llms.txt b/docs/llms.txt index 7121e4b9..618acd08 100644 --- a/docs/llms.txt +++ b/docs/llms.txt @@ -1,6 +1,6 @@ # ONVIF Python -> A modern, developer-friendly Python library for discovering, connecting to, and managing ONVIF-compliant IP cameras, NVRs, and other ONVIF-compliant devices. It provides a Pythonic interface to ONVIF SOAP services, built-in WSDL definitions, WS-Discovery, device management, media streaming, PTZ, events, analytics, and a feature-rich command-line interface. +> A modern, developer-friendly Python Library + CLI for discovering, connecting to, and managing ONVIF-compliant IP cameras, NVRs, and other ONVIF-compliant devices. It provides a Pythonic interface to ONVIF SOAP services, built-in WSDL definitions, WS-Discovery, device management, media streaming, PTZ, events, analytics, and a feature-rich command-line interface. ONVIF Python is an independent open-source implementation of the ONVIF specifications, maintained by Nirsimetri Technologies. It is designed for individual developers, companies building video management systems (VMS) and video intelligence platforms, security integrators, and IoT developers. diff --git a/docs/overrides/main.html b/docs/overrides/main.html index 44612a83..d127dc15 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -71,7 +71,7 @@ @@ -94,7 +94,7 @@ /> Date: Wed, 21 Oct 2026 03:20:28 +0700 Subject: [PATCH 36/37] chore: Exclude non-module folders --- pyproject.toml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index c408a90e..61c11e5d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -98,6 +98,9 @@ exclude = [ "build*", "site*", "device-test*", + "docs*", + "dist*", + "scripts*", ] [tool.setuptools.package-data] @@ -122,6 +125,7 @@ skip = [ "^temp/", "^build/", "^site/", + "^dist/", ] [tool.docformatter] @@ -140,6 +144,7 @@ ignore-paths = [ "^temp/", "^build/", "^site/", + "^dist/", ] load-plugins = ["pylint_pytest"] @@ -168,6 +173,8 @@ exclude = [ "^build/", "^site/", "^docs/", + "^scripts/", + "^dist/", ] [tool.coverage.run] @@ -176,6 +183,8 @@ omit = [ "device-test/*", "examples/*", "docs/*", + "scripts/*", + "dist/*", ] [tool.codespell] From c97ec28077a2346302b958e7a38b42718e2cc5c6 Mon Sep 17 00:00:00 2001 From: Kaburagi <135169292+kaburagisec@users.noreply.github.com> Date: Wed, 21 Oct 2026 03:57:51 +0700 Subject: [PATCH 37/37] code: Update example codes (#192) --- examples/add_media_profile.py | 16 ++++--- examples/add_onvif_user.py | 8 ++-- examples/check_all_capabilities.py | 10 ++-- examples/check_all_services.py | 8 ++-- examples/check_device.py | 8 ++-- examples/check_ptz.py | 8 ++-- examples/device_discovery_raw.py | 9 ++-- examples/direct_zeep.py | 75 ++++++++++++++++++++++++++++++ examples/error_handling.py | 22 ++++++--- examples/get_analytics_list.py | 8 ++-- examples/get_imaging.py | 8 ++-- examples/get_media_profiles.py | 8 ++-- examples/get_onvif_version.py | 2 +- examples/get_snapshot.py | 8 ++-- examples/open_stream.py | 4 +- examples/open_stream_with_ptz.py | 4 +- examples/pull_live_events.py | 6 +-- examples/set_device_time.py | 8 ++-- examples/set_imaging.py | 8 ++-- examples/set_irlamp.py | 8 ++-- 20 files changed, 162 insertions(+), 74 deletions(-) create mode 100644 examples/direct_zeep.py diff --git a/examples/add_media_profile.py b/examples/add_media_profile.py index 9677dcfd..49b071d5 100644 --- a/examples/add_media_profile.py +++ b/examples/add_media_profile.py @@ -17,16 +17,18 @@ 7. Verify the profile was created successfully """ -from onvif import ONVIFClient +import sys + +from onvif import ONVIFClient, ONVIFOperationException HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" try: # Initialize ONVIF client - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) + client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) media = client.media() # Get available video sources @@ -34,7 +36,7 @@ video_sources = media.GetVideoSources() if not video_sources: print("No video sources available") - exit(1) + sys.exit() print(f"Found {len(video_sources)} video source(s)") video_source_token = video_sources[0].token @@ -45,7 +47,7 @@ video_source_configs = media.GetVideoSourceConfigurations() if not video_source_configs: print("No video source configurations available") - exit(1) + sys.exit() video_source_config_token = video_source_configs[0].token print(f"Using video source configuration token: {video_source_config_token}") @@ -55,7 +57,7 @@ video_encoder_configs = media.GetVideoEncoderConfigurations() if not video_encoder_configs: print("No video encoder configurations available") - exit(1) + sys.exit() video_encoder_config_token = video_encoder_configs[0].token print(f"Using video encoder configuration token: {video_encoder_config_token}") @@ -112,7 +114,7 @@ ) print(f"Stream URI: {stream_uri.Uri}") -except Exception as e: # pylint: disable=broad-exception-caught +except (ONVIFOperationException, KeyError, AttributeError) as e: print(f"Error: {e}") import traceback diff --git a/examples/add_onvif_user.py b/examples/add_onvif_user.py index 16b17d1d..b4936866 100644 --- a/examples/add_onvif_user.py +++ b/examples/add_onvif_user.py @@ -8,15 +8,15 @@ a new user using the Core (Device Management) service. """ -from onvif import ONVIFClient +from onvif import ONVIFClient, ONVIFOperationException HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" try: - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) + client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) device = client.devicemgmt() device.CreateUsers( User=[{"Username": "newuser", "Password": "newpassword", "UserLevel": "User"}] @@ -24,5 +24,5 @@ # print current users to verify addition print(device.GetUsers()) -except Exception as e: # pylint: disable=broad-exception-caught +except ONVIFOperationException as e: print(e) diff --git a/examples/check_all_capabilities.py b/examples/check_all_capabilities.py index 6ab94a27..17a28024 100644 --- a/examples/check_all_capabilities.py +++ b/examples/check_all_capabilities.py @@ -8,16 +8,18 @@ capabilities using the Core (Device Management) service. """ -from onvif import CacheMode, ONVIFClient +from onvif import CacheMode, ONVIFClient, ONVIFOperationException HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" try: - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD, cache=CacheMode.NONE) + client = ONVIFClient( + host=HOST, port=PORT, username=USERNAME, password=PASSWORD, cache=CacheMode.NONE + ) capabilities = client.devicemgmt().GetCapabilities(Category="All") print(capabilities) -except Exception as e: # pylint: disable=broad-exception-caught +except ONVIFOperationException as e: print(e) diff --git a/examples/check_all_services.py b/examples/check_all_services.py index 3e5fb56b..495121a8 100644 --- a/examples/check_all_services.py +++ b/examples/check_all_services.py @@ -8,16 +8,16 @@ of all available services using the Core (Device Management) service. """ -from onvif import ONVIFClient +from onvif import ONVIFClient, ONVIFOperationException HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" try: - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) + client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) services = client.devicemgmt().GetServices(IncludeCapability=True) print(services) -except Exception as e: # pylint: disable=broad-exception-caught +except ONVIFOperationException as e: print(e) diff --git a/examples/check_device.py b/examples/check_device.py index 0d192ea0..2b8b4935 100644 --- a/examples/check_device.py +++ b/examples/check_device.py @@ -11,15 +11,15 @@ import json -from onvif import ONVIFClient +from onvif import ONVIFClient, ONVIFOperationException HOST = "192.168.1.3" PORT = 8000 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" try: - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) + client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) device = client.devicemgmt() # print device information @@ -27,5 +27,5 @@ # print device scopes print(json.dumps(device.to_dict(device.GetScopes()), indent=4)) -except Exception as e: # pylint: disable=broad-exception-caught +except ONVIFOperationException as e: print(e) diff --git a/examples/check_ptz.py b/examples/check_ptz.py index 3d8ca34f..7224dae4 100644 --- a/examples/check_ptz.py +++ b/examples/check_ptz.py @@ -9,15 +9,15 @@ from time import sleep -from onvif import ONVIFClient +from onvif import ONVIFClient, ONVIFOperationException HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" try: - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) + client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) media = client.media() profile = media.GetProfiles()[0] # use first profile ptz = client.ptz() @@ -33,5 +33,5 @@ ) sleep(2.5) ptz.Stop(ProfileToken=profile.token) -except Exception as e: # pylint: disable=broad-exception-caught +except (ONVIFOperationException, KeyError) as e: print(e) diff --git a/examples/device_discovery_raw.py b/examples/device_discovery_raw.py index 5e159605..1c61d128 100644 --- a/examples/device_discovery_raw.py +++ b/examples/device_discovery_raw.py @@ -20,6 +20,7 @@ import socket import struct import sys +import traceback import uuid from lxml import etree @@ -55,14 +56,14 @@ def get_network_interface(): local_ip = s.getsockname()[0] s.close() return local_ip - except Exception: + except OSError: # Try alternative method to get local IP try: hostname = socket.gethostname() local_ip = socket.gethostbyname(hostname) if local_ip and not local_ip.startswith("127."): return local_ip - except Exception: + except OSError: pass # Return empty string instead of "0.0.0.0" @@ -158,7 +159,6 @@ def send_probe_and_get_responses(network_interface=None, timeout=WS_DISCOVERY_TI except Exception as e: print(f"Error during discovery: {e}") - import traceback traceback.print_exc() @@ -346,9 +346,8 @@ def print_device_info(device, is_onvif=True): except KeyboardInterrupt: print("\n\nDiscovery interrupted by user.") sys.exit(0) - except Exception as e: + except Exception as e: # pylint: disable=broad-exception-caught print(f"\nUnexpected error: {e}") - import traceback traceback.print_exc() sys.exit(1) diff --git a/examples/direct_zeep.py b/examples/direct_zeep.py new file mode 100644 index 00000000..821058c4 --- /dev/null +++ b/examples/direct_zeep.py @@ -0,0 +1,75 @@ +""" +Path: examples/direct_zeep.py +Author: @kaburagisec +Created: October 21, 2026 + +This script demonstrates how to invoke ONVIF operations using +the `zeep` library directly, without relying on the `onvif-python` module. +""" + +from requests import Session +from requests.auth import HTTPDigestAuth +from zeep import Client, Settings +from zeep.plugins import HistoryPlugin +from zeep.transports import Transport + +HOST = "192.168.69.249" +PORT = 80 +USERNAME = "admin" +PASSWORD = "password" + +WSDL = "https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl" +ADDRESS = f"http://{HOST}:{PORT}/devicemgmt" + +session = Session() +session.auth = HTTPDigestAuth(USERNAME, PASSWORD) + +history = HistoryPlugin() + +client = Client( + wsdl=WSDL, + transport=Transport(session=session, timeout=15), + settings=Settings(strict=True, xml_huge_tree=True), + plugins=[history], +) + +service = client.create_service( + "{http://www.onvif.org/ver10/device/wsdl}DeviceBinding", + ADDRESS, +) + +for schema_type in client.wsdl.types.types: + if getattr(schema_type, "name", None) == "SystemCapabilities": + print("Type:", schema_type) + print("Attributes:") + + for attribute in schema_type.attributes: + print(" ", attribute) + +try: + result = service.GetServiceCapabilities() + + print("=== Zeep parsed result ===") + print(result) + + print("\n=== System capabilities ===") + system = result.Capabilities.System + + print("FirmwareUpgrade:", system.FirmwareUpgrade) + print("HttpFirmwareUpgrade:", system.HttpFirmwareUpgrade) + +except Exception as exc: + print(f"{type(exc).__name__}: {exc}") + +finally: + if history.last_received: + print("\n=== Raw SOAP response ===") + print( + client.transport.binding_options + if False + else __import__("lxml.etree", fromlist=["etree"]).tostring( + history.last_received["envelope"], + pretty_print=True, + encoding="unicode", + ) + ) diff --git a/examples/error_handling.py b/examples/error_handling.py index dc2ba409..ffbb10ad 100644 --- a/examples/error_handling.py +++ b/examples/error_handling.py @@ -26,7 +26,7 @@ HOST = "192.168.1.14" PORT = 2020 USERNAME = "admintapo" -PASSWORD = "admin123" +PASSWORD = "password" def example_1_safe_call(): @@ -40,7 +40,9 @@ def example_1_safe_call(): print("Example 1: Using safe_call") print("=" * 60) - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD, cache=CacheMode.NONE) + client = ONVIFClient( + host=HOST, port=PORT, username=USERNAME, password=PASSWORD, cache=CacheMode.NONE + ) device = client.devicemgmt() # Returns None if operation is not supported @@ -68,7 +70,9 @@ def example_2_decorator(): print("Example 2: Using @ignore_unsupported decorator") print("=" * 60) - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD, cache=CacheMode.NONE) + client = ONVIFClient( + host=HOST, port=PORT, username=USERNAME, password=PASSWORD, cache=CacheMode.NONE + ) device = client.devicemgmt() @ignore_unsupported @@ -105,7 +109,9 @@ def example_3_manual_handling(): print("Example 3: Manual exception handling") print("=" * 60) - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD, cache=CacheMode.NONE) + client = ONVIFClient( + host=HOST, port=PORT, username=USERNAME, password=PASSWORD, cache=CacheMode.NONE + ) device = client.devicemgmt() # Try GetSystemUris (not always supported), fallback to alternative @@ -167,7 +173,9 @@ def example_4_batch_operations(): print("Example 4: Batch operations with graceful degradation") print("=" * 60) - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD, cache=CacheMode.NONE) + client = ONVIFClient( + host=HOST, port=PORT, username=USERNAME, password=PASSWORD, cache=CacheMode.NONE + ) device = client.devicemgmt() # Define operations to try @@ -214,7 +222,9 @@ def example_5_critical_operations(): print("Example 5: Critical operations (don't ignore errors)") print("=" * 60) - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD, cache=CacheMode.NONE) + client = ONVIFClient( + host=HOST, port=PORT, username=USERNAME, password=PASSWORD, cache=CacheMode.NONE + ) device = client.devicemgmt() # Critical operation - must succeed diff --git a/examples/get_analytics_list.py b/examples/get_analytics_list.py index a5c41778..af4f336f 100644 --- a/examples/get_analytics_list.py +++ b/examples/get_analytics_list.py @@ -8,15 +8,15 @@ analytics modules using the Analytics service. """ -from onvif import ONVIFClient +from onvif import ONVIFClient, ONVIFOperationException HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" try: - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) + client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) profile = client.media().GetProfiles()[0] # use the first profile analytics = client.analytics() @@ -29,5 +29,5 @@ ConfigurationToken=profile.VideoAnalyticsConfiguration.token ) print("Supported Analytics Modules:\n{}".format(supported_analytics_modules)) -except Exception as e: +except (ONVIFOperationException, KeyError) as e: print(e) diff --git a/examples/get_imaging.py b/examples/get_imaging.py index d2cd8ddb..e4b1f737 100644 --- a/examples/get_imaging.py +++ b/examples/get_imaging.py @@ -8,15 +8,15 @@ imaging settings using the Imaging service from the first media profile. """ -from onvif import ONVIFClient +from onvif import ONVIFClient, ONVIFOperationException HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" try: - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) + client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) profile = client.media().GetProfiles()[0] # use the first profile imaging = client.imaging() @@ -25,5 +25,5 @@ VideoSourceToken=profile.VideoSourceConfiguration.SourceToken ) ) -except Exception as e: # pylint: disable=broad-exception-caught +except (ONVIFOperationException, KeyError) as e: print(e) diff --git a/examples/get_media_profiles.py b/examples/get_media_profiles.py index 986c03dc..faf5f583 100644 --- a/examples/get_media_profiles.py +++ b/examples/get_media_profiles.py @@ -8,18 +8,18 @@ the media profiles using the Media service. """ -from onvif import ONVIFClient +from onvif import ONVIFClient, ONVIFOperationException HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" try: - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) + client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) device = client.media() # print available media profiles print(device.GetProfiles()) -except Exception as e: # pylint: disable=broad-exception-caught +except ONVIFOperationException as e: print(e) diff --git a/examples/get_onvif_version.py b/examples/get_onvif_version.py index 090f424f..143179ab 100644 --- a/examples/get_onvif_version.py +++ b/examples/get_onvif_version.py @@ -13,7 +13,7 @@ HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" try: client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) diff --git a/examples/get_snapshot.py b/examples/get_snapshot.py index e5e09fb0..d167aa31 100644 --- a/examples/get_snapshot.py +++ b/examples/get_snapshot.py @@ -8,15 +8,15 @@ the snapshot URI using the Media service. """ -from onvif import ONVIFClient +from onvif import ONVIFClient, ONVIFOperationException HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" try: - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) + client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) media = client.media() profile = media.GetProfiles()[0] # use the first profile @@ -24,5 +24,5 @@ snapshot_uri = media.GetSnapshotUri(ProfileToken=profile.token) print("Snapshot URI:", snapshot_uri.Uri) -except Exception as e: # pylint: disable=broad-exception-caught +except (ONVIFOperationException, KeyError) as e: print(e) diff --git a/examples/open_stream.py b/examples/open_stream.py index f1b0b03c..9e6b29eb 100644 --- a/examples/open_stream.py +++ b/examples/open_stream.py @@ -18,9 +18,9 @@ HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" -client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) +client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) media = client.media() profile = media.GetProfiles()[0] # use the first profile diff --git a/examples/open_stream_with_ptz.py b/examples/open_stream_with_ptz.py index d64124d6..f731e697 100644 --- a/examples/open_stream_with_ptz.py +++ b/examples/open_stream_with_ptz.py @@ -19,9 +19,9 @@ HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" -client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) +client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) media = client.media() ptz = client.ptz() diff --git a/examples/pull_live_events.py b/examples/pull_live_events.py index 5fa9b421..fefbb628 100644 --- a/examples/pull_live_events.py +++ b/examples/pull_live_events.py @@ -12,12 +12,12 @@ import datetime -from onvif import ONVIFClient, ONVIFParser +from onvif import ONVIFClient, ONVIFOperationException, ONVIFParser HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" # Create parser to extract Topic elements from SOAP responses parser = ONVIFParser( @@ -118,7 +118,7 @@ print("\n-> Event without Message") else: print("\n-> 🔁 No new events.") - except Exception as e: # pylint: disable=broad-exception-caught + except (ONVIFOperationException, AttributeError, ValueError, KeyError) as e: print("\n-> ❌ Error while pulling events:", e) # time.sleep(1) # small delay between requests diff --git a/examples/set_device_time.py b/examples/set_device_time.py index b52bd0c0..98b52094 100644 --- a/examples/set_device_time.py +++ b/examples/set_device_time.py @@ -10,15 +10,15 @@ from datetime import datetime -from onvif import ONVIFClient +from onvif import ONVIFClient, ONVIFOperationException HOST = "192.168.1.14" PORT = 2020 USERNAME = "admintapo" -PASSWORD = "admin123" +PASSWORD = "password" try: - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) + client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) device_service = client.devicemgmt() system_date_time = device_service.GetSystemDateAndTime() @@ -49,5 +49,5 @@ system_date_time_after = device_service.GetSystemDateAndTime() print(f"Updated System Date and Time: {system_date_time_after}\n") -except Exception as e: # pylint: disable=broad-exception-caught +except (ONVIFOperationException, ValueError, AttributeError) as e: print(e) diff --git a/examples/set_imaging.py b/examples/set_imaging.py index 2d459ecd..3901a1d7 100644 --- a/examples/set_imaging.py +++ b/examples/set_imaging.py @@ -8,15 +8,15 @@ with defined parameters. """ -from onvif import ONVIFClient +from onvif import ONVIFClient, ONVIFOperationException HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" try: - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) + client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) media = client.media() profile = media.GetProfiles()[0] # use first profile video_source_token = profile.VideoSourceConfiguration.SourceToken @@ -32,5 +32,5 @@ ) print(imaging.GetImagingSettings(VideoSourceToken=video_source_token)) -except Exception as e: # pylint: disable=broad-exception-caught +except (ONVIFOperationException, KeyError) as e: print(e) diff --git a/examples/set_irlamp.py b/examples/set_irlamp.py index e8746010..f78c21ec 100644 --- a/examples/set_irlamp.py +++ b/examples/set_irlamp.py @@ -8,15 +8,15 @@ to ON, OFF, or AUTO mode using the Imaging service. """ -from onvif import ONVIFClient +from onvif import ONVIFClient, ONVIFOperationException HOST = "192.168.1.3" PORT = 80 USERNAME = "admin" -PASSWORD = "admin123" +PASSWORD = "password" try: - client = ONVIFClient(HOST, PORT, USERNAME, PASSWORD) + client = ONVIFClient(host=HOST, port=PORT, username=USERNAME, password=PASSWORD) media = client.media() profile = media.GetProfiles()[0] # use first profile video_source_token = profile.VideoSourceConfiguration.SourceToken @@ -30,5 +30,5 @@ ) print(imaging.GetImagingSettings(VideoSourceToken=video_source_token)) -except Exception as e: # pylint: disable=broad-exception-caught +except (ONVIFOperationException, KeyError) as e: print(e)